Skip to main content

Setup Mobile Gateway and Edgepoint

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 Mobile Gateway​

Required information

  • name: Name for the Mobile Gateway, needs to be unique in your account.
  • edgelocation: The (Alef) Edge Location to deploy the gateway to. (CHI-1, DEN-1, PHI-1).
  • tac: TAC value to assign to this gateway. This needs to be unique and part of the range as provisioned with the Mobile Core.
  • generation: 4G or 5G (4G is default)
  • sgw ip: SGW IP address for your Mobile Gateway (must be a /30 range). A small IP subnet needs to be allocated for the communication between your radio network and the mobile gateway. This is called the sgw ip and is defined as a /30 subnet. Alef will use this to assign the SGW IP and this range needs to be routable from your network. This range can be a subrange of the eNB subnet as specified in the Mobile Core, but can't overlap with IP assigned to the MME or Radios.

You will use the following POST request body with the /connectivity/v2/networks/{mobilecoreId}/gateway endpoint to create and configure your Mobile Gateway.

You can use the following GET request body with the /connectivity/v2/networks/{mobilecoreId}/gateway/{id} endpoint to retrieve your Mobile Gateway provision status and information.

Expand here to see the create mobile gateway POST request body. 
  {
      "name": "Edge-Gateway-1",
      "edgelocation": "PHI-1",
      "tac": "3",
      "generation": "4G",
      "served-ran-ids": [
      "66c7553603ffb584d8338c4e"
      ],
      "sgw": "173.53.1.250/30"  
  }

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 Gateway POST and GET requests and responses.

Request

curl -X 'POST' 'https://api.alefedge.com/connectivity/v2/networks/66c7553603ffb584d8338c4a/gateway' \
  -H 'Authorization: Bearer <JWT TOKEN>' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d ' {
      "name": "Edge-Gateway-1",
      "edgelocation": "PHI-1",
      "generation": "4G",
      "tac": "3",
      "sgw": "173.53.1.250/30"
  }'

Response

  {
    "account_id": "66992fb6310e8d77a42ed77a",
    "name": "Edge-Gateway-1",
    "mobile-core-id": "66c7553603ffb584d8338c4a",
    "generation": "4G",
    "edgelocation": "PHI-1",
    "served-ran-ids": [
      "66c7553603ffb584d8338c4e"
    ],
    "tac": "3",
    "sgw": "173.53.1.250/30",
    "_id": "66c75ae54333dcc27fbce39d",
    "__v": 0
  }
tip

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

Configure your EdgePoint​

Required information

  • name: Name for your EdgePoint, needs to be unique in your account
  • mobilecore_id: The Object ID of the Mobile Core that this EdgePoint will connect to.
  • mobilegateways: The Object ID of the Mobile Gateway that this EdgePoint will connect to.
  • ran_ids: The Object ID of the RAN that this EdgePoint will connect to.
note

The mobilegateways and ran_ids will currently only take one value.

You will use the following POST request body with the /connectivity/v2/networks/edgepoint to create and configure your EdgePoint.

Expand here to see the create edgepoint POST request body. 
{
  "name": "string",
  "mobilecore_id": "66c75ae54333dcc27fbce394",
  "mobilegateways": [
    "66c75ae54333dcc27fbce39d"
  ],
  "ran_ids": [
    "66c7553603ffb584d8338c4e"
  ]
}

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 EdgePoint POST request and response.

Request

curl -X 'POST' 'https://api.alefedge.com/connectivity/v2/networks/edgepoint' \
  -H 'Authorization: Bearer <JWT TOKEN>' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d ' {
    "name": "string",
    "mobilecore_id": "66c75ae54333dcc27fbce394",
    "mobilegateways": [
      "66c75ae54333dcc27fbce39d"
    ],
    "ran_ids": [
      "66c7553603ffb584d8338c4e"
    ]
  }'

Response

{
    "account_id": "66992fb6310e8d77a42ed77a",
    "name": "Alef Demo Mobile",
    "mobilecore_id": "66c75ae54333dcc27fbce394",
    "mobilegateways": [
      "66c75ae54333dcc27fbce39d"
    ],
    "ran_ids": [
      "66c7553603ffb584d8338c4e"
    ],
    "_id": "66c75ae64333dcc27fbce3b0",
    "__v": 0
}
tip

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