...
|
Resource
Resource for this interface
/v#/nodeb
Description
E2 Manager exchange with this eNodeb RAN Setup Request and Response.
HTTP Method
POST
Supported Representation Formats
Request: Request Format ie application/json, none, etc
Response: Response Format ie application/json, none, etc
Successful HTTP Response Code
204 No Content
Code Block | ||||
---|---|---|---|---|
| ||||
POST http://<serverBaseURL>/v#/nodeb/x2-setup |
Request Data Details
Listed below are the key elements included in the request.
...
Location
...
accept
...
Header
...
String
...
Status | ||||
---|---|---|---|---|
|
...
Refer to Standard API Request Headers
...
content-type
...
Header
...
String
...
Status | ||||
---|---|---|---|---|
|
...
Refer to Standard API Request Headers
...
ranIp
...
Body
...
String
...
Status | ||||
---|---|---|---|---|
|
...
IP of the RAN
...
ranPort
...
Body
...
Int
...
Status | ||||
---|---|---|---|---|
|
...
Port of the RAN
...
ranName
...
Body
...
String
...
Status | ||||
---|---|---|---|---|
|
...
Name of the RAN
Code Block | ||||
---|---|---|---|---|
| ||||
POST http://localhost:3800/v1/nodeb/x2-setup
accept: application/json
content-Type: application/json
{
"ranIp":"10.0.2.15",
"ranPort":5577,
"ranName": "test1"
} |
Response Data Details
The body is empty in case 204 No Content, and with specific HTTP code and error details in case failure
|
...
Code Block | ||||
---|---|---|---|---|
| ||||
GET http://<serverBaseURL>/v#/health |
Request Data Details
Listed below are the key elements included in the request.
...
Code Block | ||||
---|---|---|---|---|
| ||||
GET http://localhost:3800/v1/health accept: application/json |
Response Data Details
The body is empty in case 200 OK. No other response expected. If no answer - there is a problem....
...
Code Block | ||||
---|---|---|---|---|
| ||||
GET http://<serverBaseURL>/v#/nodeb/<ranName> |
Request Data Details
Listed below are the key elements included in the request.
...
Code Block | ||||
---|---|---|---|---|
| ||||
GET http://localhost:3800/v1/nodeb/NYC213123 accept: application/json Content-Type: application/json |
Response Data Details
In case 200 OK, this is the payload
...
|
Request Data Details
# | Parameter | Location | Data Type | Required? | Value Rules |
---|---|---|---|---|---|
accept | Header | String | YES | Refer to Standard API Request Headers | |
content-type | Header | String | YES | Refer to Standard API Request Headers | |
servedNrCells | Body | Array of Object | YES | Please refer to Served NR Cells array inside the gNB Object (In the Get NodeB Response) |
...
Code Block | ||||
---|---|---|---|---|
| ||||
PUT http://localhost:3800/v1/nodeb/test1/update accept: application/json { "servedNrCells": [ { "servedNrCellInformation": { "nrPci": 100, "cellId": "02f829:0007ab0178", "servedPlmns": [ "02f829" ], "nrMode": "FDD", "choiceNrMode": { "fdd": { "ulFreqInfo": { "nrArFcn": "100", "frequencyBands": [ { "nrFrequencyBand": 9, "supportedSulBands": [ 9 ] } ] }, "dlFreqInfo": { "nrArFcn": "100", "frequencyBands": [ { "nrFrequencyBand": 9, "supportedSulBands": [ 9 ] } ] }, "ulTransmissionBandwidth": { "nrscs": "SCS15", "ncnrb": "NRB11" }, "dlTransmissionBandwidth": { "nrscs": "SCS15", "ncnrb": "NRB11" } } } }, "nrNeighbourInfos": [ { "nrCgi": "string", "choiceNrMode": { "fdd": { "ulFreqInfo": { "nrArFcn": "100", "frequencyBands": [ { "nrFrequencyBand": 9, "supportedSulBands": [ 9 ] } ] }, "dlFreqInfo": { "nrArFcn": "100", "frequencyBands": [ { "nrFrequencyBand": 9, "supportedSulBands": [ 9 ] } ] }, "ulTransmissionBandwidth": { "nrscs": "SCS15", "ncnrb": "NRB11" }, "dlTransmissionBandwidth": { "nrscs": "SCS15", "ncnrb": "NRB11" } } }, "configuredStac": "string", "nrPci": 200, "nrMode": "FDD", "stac5g": "string" }, { "nrCgi": "string", "choiceNrMode": { "fdd": { "ulFreqInfo": { "nrArFcn": "100", "frequencyBands": [ { "nrFrequencyBand": 9, "supportedSulBands": [ 9 ] } ] }, "dlFreqInfo": { "nrArFcn": "100", "frequencyBands": [ { "nrFrequencyBand": 9, "supportedSulBands": [ 9 ] } ] }, "ulTransmissionBandwidth": { "nrscs": "SCS15", "ncnrb": "NRB11" }, "dlTransmissionBandwidth": { "nrscs": "SCS15", "ncnrb": "NRB11" } } }, "configuredStac": "string", "nrPci": 201, "nrMode": "FDD", "stac5g": "string" } ] }, { "servedNrCellInformation": { "nrPci": 101, "cellId": "02f829:0007ab0120", "servedPlmns": [ "02f829" ], "nrMode": "FDD", "choiceNrMode": { "fdd": { "ulFreqInfo": { "nrArFcn": "100", "frequencyBands": [ { "nrFrequencyBand": 9, "supportedSulBands": [ 9 ] } ] }, "dlFreqInfo": { "nrArFcn": "100", "frequencyBands": [ { "nrFrequencyBand": 9, "supportedSulBands": [ 9 ] } ] }, "ulTransmissionBandwidth": { "nrscs": "SCS15", "ncnrb": "NRB11" }, "dlTransmissionBandwidth": { "nrscs": "SCS15", "ncnrb": "NRB11" } } } }, "nrNeighbourInfos": [ { "nrCgi": "string", "choiceNrMode": { "fdd": { "ulFreqInfo": { "nrArFcn": "100", "frequencyBands": [ { "nrFrequencyBand": 9, "supportedSulBands": [ 9 ] } ] }, "dlFreqInfo": { "nrArFcn": "100", "frequencyBands": [ { "nrFrequencyBand": 9, "supportedSulBands": [ 9 ] } ] }, "ulTransmissionBandwidth": { "nrscs": "SCS15", "ncnrb": "NRB11" }, "dlTransmissionBandwidth": { "nrscs": "SCS15", "ncnrb": "NRB11" } } }, "configuredStac": "string", "nrPci": 300, "nrMode": "FDD", "stac5g": "string" } ] } ] } |
Response Data Details
In case 200 OK, the payload is identical to Get NodeB <RAN Name>.
...
|
Request Data Details
# | Parameter | Location | Data Type | Required? | Value Rules |
---|---|---|---|---|---|
1 | accept | Header | String | YES | Refer to Standard API Request Headers |
2 | content-type | Header | String | YES | Refer to Standard API Request Headers |
3 | enbNode | Body | Object | YES | Please refer to ENB Node |
4 | servedCells | Body | Array of Object | YES | Please refer to Served Cells array inside the eNB Object (In the Get NodeB Response) |
...
# | Parameter | Data Type | Required? | Value Rules |
---|---|---|---|---|
1 | enbType | ENUM | YES | |
2 | ranName | String | YES | |
3 | globalNbId | Object | NO | Refer to object globalNbId |
4 | ip | String | NO | |
5 | port | Integer | NO | |
6 | guGroupIds | Array of String | NO |
Example (TBD)
Response Data Details
In case 201 CREATED, the payload is identical to Get NodeB <RAN Name>.
...
|
Request Data Details
# | Parameter | Location | Data Type | Required? | Value Rules |
---|---|---|---|---|---|
1 | accept | Header | String | YES | Refer to Standard API Request Headers |
2 | content-type | Header | String | YES | Refer to Standard API Request Headers |
3 | enbNode | Body | Object | YES | Please refer to ENB Node |
4 | servedCells | Body | Array of Object | YES | Please refer to Served Cells array inside the eNB Object (In the Get NodeB Response) |
Response Data Details
In case 200 OK, the payload is identical to Get NodeB <RAN Name>.
...
|
Request Data Details
# | Parameter | Location | Data Type | Required? | Value Rules |
---|---|---|---|---|---|
1 | accept | Header | String | YES | Refer to Standard API Request Headers |
2 | content-type | Header | String | YES | Refer to Standard API Request Headers |
3 | enbNode | Body | Object | YES | Please refer to ENB Node |
4 | servedCells | Body | Array of Object | YES | Please refer to Served Cells array inside the eNB Object (In the Get NodeB Response) |
Response Data Details
In case success - 204 No Content
...
Code Block | ||||
---|---|---|---|---|
| ||||
PUT http://<serverBaseURL>/v#/nodeb/shutdown |
Request Data Details
Listed below are the key elements included in the request.
...
Code Block | ||||
---|---|---|---|---|
| ||||
PUT http://localhost:3800/v1/nodeb/shutdown accept: application/json |
Response Data Details
There is no Body in case 204 No Content, and with 202 Accepted with error details in case failure such as Routing Manager (511)
...
|
Request Data Details
Listed below are the key elements included in the request.
...
|
Response Data Details
In case 200 OK, this is the payload
...
|
Request Data Details
Listed below are the key elements included in the request.
...
|
Response Data Details
In case 200 OK, this is the payload
...
|
Request Data Details
Listed below are the key elements included in the request.
...
|
Response Data Details
202 Accepted or error.
11. Get All E2T Request |
...
|
Request Data Details
Listed below are the key elements included in the request.
...
|
Response Data Details
In case 200 OK, this is the payload
...
|
Request Data Details
Listed below are the key elements included in the request.
...
{ "enableRic": true, } |
Response Data Details
200 OK with the list of All parameters or error