JSON API for YateUCN Configuration

{ “node_type”: “ucn” / “stp”,
  “ss7”: {
    “local”: {
      “common”: {
          “dialect”: “ITU” / “ANSI”,
          “netindicator”: “national” / “reservednational” / “international”,
          “pointcode”: NNN, // integer representation, range depends on dialect
          “gt”: “NNNNNNNNNN”,
          “ip”: [“x.x.x.x” / “xx:xx::xx”], // Local IP address for signaling protocols
          “nnsf_node”: NNN, // Node Resource Index for Network Node Selection Function
          “nnsf_bits”: N, // Bits used from (P)TMSI for NNSF
          “ip_gtp”: “x.x.x.x” / “xx:xx::xx”, // IP address for GTP
          “def_smsc”: “NNNNNNNNNN”, // optional GT to use instead of malformed SMSC
          “empty_begin”: false / true / 0 / 1, // start SMS delivery with an empty TCAP Begin
      },
      “vlr”: {  // parameters and overrides for UCN/VLR+MSC only
        “nnsf_node”: NNN,  // optional override
        “nnsf_bits”: N,  // optional override
      },
      “sgsn”: {  // parameters and overrides for UCN/SGSN only
        “nnsf_node”: NNN,  // optional override
        “nnsf_bits”: N,  // optional override
     },
     “mme”: {  // parameters and overrides for UCN/MME only
       “identity”: {
          “plmns”: [ “NNNNN”, “NNNNNN”, … ],  // List of MCCMNC
          “tac”: NNN,
          “group”: NNN,
          “code”: NN,  // LTE specific nnsf_node override, must be unique per group, 0 to 255
          “name”: “some-name-here”,  // optional
        },
     },
     “pgw”: {  // parameters and overrides for UCN/PGW only
       “ip_gtp_c”: “x.x.x.x” / “xx:xx::xx”,  // IP address for GTP-C
       “ip_gtp_u”: “x.x.x.x” / “xx:xx::xx”,  // IP address for GTP-U
         },
      },
      “linksets”: [
         { “type”: “MTP3” / “M3UA”,
           “pointcode”: NNN,  // integer representation, range depends on dialect
           “route”: [ NNN, NNN, … ],  // List of PCs in integer representation to route through this STP
           “gt”: [ “NNNNN”, “NNNNN”, … ],  // List of GT prefixes to route through this STP, can be just [ “*” ]
           “ip”: [“x.x.x.x” / “xx:xx::xx”],  // Remote IP address
           “aspid”: NNN               // only for M3UA
           “contexts”: N, N, …     // only for M3UA, comma separated list of context numbers
           “links”: [
               { “port”: ,    // port on the adjacent node
                 “local_ip”: []  // optional local IP address
                 “local_port”:  // optional local port number
               },
               // … other links if necessary
          ]
        },
        // … linkset for the second STP
     ],
  }
  “access_points”: [                  // only for ucn node
        { “name”: “ap-name-without-dots”,
          “tunnel”: “name-of-the-tunnel”,  // must match one entry in tunnels – see below
          “aliases”: “comma, separated, list, of.other.names”,   // optional
          “ipv”: “ipv4” / “ipv6” / “ipv4v6” / “ipv4_or_v6” / “ipv6_or_v4”,
          “qos”: “xx xx xx”, // optional, 2G/3G specific, hex encoded
          “qci”: N, // optional, 4G specific, 1 to 9
          “ordered_delivery”: false / true / 0 / 1, // not recommended – advanced setting
          “charging”: false / true / 0 / 1,
          // Protocol Configuration Options
          “primary_dns_ipv4”: “x.x.x.x”, // optional but likely needed
          “secondary_dns_ipv4”: “x.x.x.x”, // optional
          “primary_dns_ipv6”: “xx:xx::xx”, // optional but likely needed for IPv6 capable APs
          “secondary_dns_ipv6”: “xx:xx::xx”, // optional
          “p_cscf_ipv4”: “x.x.x.x”, // optional but likely needed for AP “ims”
          “p_cscf_ipv6”: “xx:xx::xx”, // optional
          “mtu_ipv4”: NNNN, // optional, 552 to 9216
          “restart_cdr”:NNNNNNN, // optional, 300 to 2678400 seconds. Interval at which CDRs should be restarted for an active data session
          “interim_cdr”:NNNNN // optional, 30 to 86400 seconds. Interval at which interim CDRs should be generated for an active data session
       },
       // … arbitrary number of APs
    ],
     “tunnels”: [                          // only for ucn node
          { “name”: “name-of-the-tunnel”,
            “ipv4_gtpu_address”: “x.x.x.x”, // optional
            “ipv6_gtpu_address”: “xx:xx::xx”, // optional, but at least one of them should be present
            “dscp”: “normal” / “expedited” / … , // search in Socket.cpp for: // DSCP
            “dscp_per_qci”: { // optional
               “N”: “normal” / “expedited” / … , // N can be 1 to 9
               “N”: “normal” / “expedited” / … , // can be repeated multiple times
           },
           // End user IP allocation pools
            “pool_ipv4”: [   // optional
                “x.x.x.x-x.x.x.x”,
                “x.x.x.x-x.x.x.x”, // can be repeated multiple times
           ],
           “pool_ipv6”: [   // optional
               “xx:xx:xx:xx::-xx:xx:xx:xx::”, // only the upper 64 bits can be specified
               “xx:xx:xx:xx::-xx:xx:xx:xx::”, // can be repeated multiple times
           ],
       },
        // … arbitrary number of tunnels
    ]
}