Skip to main content

Set your Radio Access Network (RAN)

info

You will be using the Alef Mobile Network API to carry out the tasks in this section. This is a basic config, Refer to the API reference documentation to learn more about the API and explore the full schema.

Configure your Radio Access Network​

Required information

  • name: Name for the RAN, needs to be unique in your account.
  • site_id: The Object ID of the Customer Site this RAN is located at.
  • ran-ip-subnet: The IP subnet that is used for this RAN. Needs to be the same or a subset of the range specified for the selected Mobile Core.
  • generation: 4G or 5G (4G is default)
  • mobile-core-id: The Object ID of the Mobile Core that this Radionetwork will connect to.
  • mobile-access-point: Information on the Radio(s) that you are deploying:
    • name: Radio name.
    • ip-addr: IP address for the Radio. Must be inside the ran-ip-subnet range.
    • mac-address: (Optional) The Radio network MAC address. This is needed for direct IPsec connections.
    • access-point-id: Identifier for the Radio.
    • cell: (Optional) The Cell IDs of the Access Point cells.
    • manufacturer: Name of the radio manufacturer and the SAS provider used (CBRS only).
    • geolocation: The latitude and longitude for the Radio.
note

This information is used to provision the Mobile Core and Gateway in the Alef platform. It will not provison the Radios themselves.

tip

Once you have installed your mobile APs, and provisioned connectivity from them to your SAS provider, we can assist you with the configuration they need to communicate with the Mobile Gateway on the Edge Point.

You will use the following POST request body with the /connectivity/v2/networks/ran endpoint to create and configure your RAN.

You can use the following GET request body with the /connectivity/v2/networks/ran/:id endpoint to retrieve your RAN information.

Expand here to see the RAN POST request body. 
  {
    "name": "My-First-RAN",
    "site_id": "66993642310e8d77a42ed780",
    "ran-ip-subnet": "168.53.1.0/24",
    "generation": "4G",
    "mobile-core-id": "66c75ae54333dcc27fbce394",
    "mobile-access-point": [
      {
        "name": "RAN-1",
        "ip-addr": "168.53.1.25",
        "mac-address": "48:BF:74:1E:4C:FD",
        "access-point-id": "id-45",
        "cell": [
          {
            "cell-id": "138189306"
          }
        ],
        "manufacturer": {
          "name": "Baicells",
          "cbrs-sas-account": "Goodle"
        },
        "geolocation": {
          "latitude": 90,
          "longitude": 180
        }
      }
    ]
  }

Examples​

info

All APIs require the user to be authenticated with their username/password. The JWT token needs to be added to the header as Bearer of each call.

Expand here to see examples for Mobile Core POST and GET requests and responses.

Request

curl -X 'POST' 'https://api.alefedge.com/connectivity/v2/networks/ran' \
  -H 'Authorization: Bearer <JWT TOKEN>' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d ' {
      "name": "My-First-RAN",
      "site_id": "66993642310e8d77a42ed780",
      "generation": "4G",
      "mobile-core-id": "66c75ae54333dcc27fbce394",
      "number-of-access-points": 1,
      "ran-ip-subnet": "168.53.1.0/24",
      "mobile-access-point": [
        {
          "name": "RAN-1",
          "access-point-id": "id-45",
          "cell":  [
            {
              "cell-id": "138189306"
            }
          ],
          "ip-addr": "168.53.1.25",
          "mac-address": "string",
          "manufacturer": 
          {
            "name": "Baicells",
            "cbrs-sas-account": "Goodle"
          },
          "geolocation": 
          {
            "latitude": 90,
            "longitude": 180
          }
        }
      ],
  }'

Response

{
    "account_id": "66992fb6310e8d77a42ed77a",
    "name": "My-First-RAN",
    "site_id": "66993642310e8d77a42ed780",
    "generation": "4G",
    "mobile-core-id": "66c7553603ffb584d8338c4a",
    "number-of-access-points": 1,
    "ran-ip-subnet": "168.53.1.0/24",
    "mobile-access-point": [
      {
        "name": "RAN-1",
        "access-point-id": "id-45",
        "cell": [
          {
            "cell-id": "xyz"
          }
        ],
        "ip-addr": "168.53.1.25",
        "mac-address": "string",
        "manufacturer": {
          "name": "Baicells",
          "cbrs-sas-account": "Goodle"
        },
        "geolocation": {
          "latitude": 90,
          "longitude": 180
        }
      }
    ],
    "_id": "66c7553603ffb584d8338c4e",
    "__v": 0
}
tip

Take a note of the returned object ID _id for your RAN, as you will need it in the following steps. It will be an alphanumeric string, something like 66c7553603ffb584d8338c4e.