ajay | 8794529 | 2021-12-08 00:52:00 -0800 | [diff] [blame^] | 1 | Configuration using REST Interface |
| 2 | ================================== |
| 3 | |
| 4 | You can decide to use any other tool to generate REST messages towards SD-Core to configure |
| 5 | subscribers, device groups and network slice |
| 6 | |
| 7 | |
| 8 | Subscriber Configuration through REST Interface |
| 9 | """"""""""""""""""""""""""""""""""""""""""""""" |
| 10 | |
| 11 | Below example configures subscriber `208014567891209` in the SD-Core |
| 12 | |
| 13 | .. code-block:: |
| 14 | |
| 15 | - Post: |
| 16 | URL: `http://<config-service-name-or-ip>:<port>/api/subscriber/<imsi-xxx>` |
| 17 | Ex: `http://<config-service-name-or-ip>:<port>/api/subscriber/<imsi-208014567891209>` |
| 18 | |
| 19 | Request Body: |
| 20 | |
| 21 | { |
| 22 | "UeId":"208014567891209", |
| 23 | "plmnId":"20801", |
| 24 | "opc":"d4416644f6154936193433dd20a0ace0", |
| 25 | "key":"465b5ce8b199b49faa5f0a2ee238a6bc", |
| 26 | "sequenceNumber":"96" |
| 27 | } |
| 28 | |
| 29 | - Delete: |
| 30 | URL: `http://<config-service-name-or-ip>:<port>/api/subscriber/<imsi-xxx>` |
| 31 | Ex: `http://<config-service-name-or-ip>:<port>/api/subscriber/<imsi-208014567891209>` |
| 32 | |
| 33 | |
| 34 | Device Group Configuration through REST Interface |
| 35 | """"""""""""""""""""""""""""""""""""""""""""""""" |
| 36 | |
| 37 | .. code-block:: |
| 38 | |
| 39 | - Post: |
| 40 | URL: `http://<config-service-name-or-ip>:<port>/device-group/<group-name>` |
| 41 | Ex: `http://config5g:8080/device-group/iot-camera` |
| 42 | |
| 43 | Request Body: |
| 44 | { |
| 45 | "imsis": |
| 46 | [ |
| 47 | "123456789123456" |
| 48 | "123456789123457" |
| 49 | "123456789123458" |
| 50 | ], |
| 51 | "site-info": "menlo", |
| 52 | "ip-domain-name": "pool1", |
| 53 | "ip-domain-expanded": |
| 54 | { |
| 55 | "dnn": "internet", |
| 56 | "ue-ip-pool": "10.91.0.0/16", |
| 57 | "dns-primary": "8.8.8.8", |
| 58 | "dns-secondary": "8.8.4.4", |
| 59 | "mtu": 1460, |
| 60 | "ue-dnn-qos": |
| 61 | { |
| 62 | "dnn-mbr-uplink": 4000000, |
| 63 | "dnn-mbr-downlink": 20000000, |
| 64 | "bitrate-unit": "Mbps", |
| 65 | "traffic-class": "platinum" |
| 66 | } |
| 67 | } |
| 68 | } |
| 69 | |
| 70 | - Delete |
| 71 | URL: `http://<config-service-name-or-ip>:<port>/device-group/<group-name>` |
| 72 | Ex: `http://config5g:8080/device-group/iot-camera` |
| 73 | |
| 74 | Network Slice Configuration through REST Interface |
| 75 | """""""""""""""""""""""""""""""""""""""""""""""""" |
| 76 | |
| 77 | .. code-block:: |
| 78 | |
| 79 | - Post: |
| 80 | URL: `http://<config-service-name-or-ip>:<port>/network-slice/<slice-name>` |
| 81 | Ex: `http://config5g:8080/network-slice/slice1` |
| 82 | |
| 83 | |
| 84 | Request Body: |
| 85 | { |
| 86 | "slice-id": |
| 87 | { |
| 88 | "sst": "1", |
| 89 | "sd": "010203" |
| 90 | }, |
| 91 | "qos": |
| 92 | { |
| 93 | "uplink": 4000000, |
| 94 | "downlink": 20000000, |
| 95 | "bitrate-unit": "Mbps", |
| 96 | "traffic-class": "platinum" |
| 97 | }, |
| 98 | "site-device-group": |
| 99 | [ |
| 100 | "iot-camera" |
| 101 | ], |
| 102 | "site-info": |
| 103 | { |
| 104 | "site-name": "menlo", |
| 105 | "plmn": |
| 106 | { |
| 107 | "mcc": "315", |
| 108 | "mnc": "010" |
| 109 | }, |
| 110 | "gNodeBs": |
| 111 | [ |
| 112 | { |
| 113 | "name": "menlo-gnb1", |
| 114 | "tac": 1 |
| 115 | } |
| 116 | ], |
| 117 | "upf": |
| 118 | { |
| 119 | "upf-name": "upf.menlo.aetherproject.org", |
| 120 | "upf-port": 8805 |
| 121 | } |
| 122 | }, |
| 123 | } |
| 124 | |
| 125 | - Delete |
| 126 | URL: `http://<config-service-name-or-ip>:<port>/network-slice/<slice-name>` |
| 127 | Ex: `http://config5g:8080/network-slice/slice1` |
| 128 | |
| 129 | |