4 Configure NSSF using REST Interface

Before configuring NSSF using REST APIs, ensure that the NSSF is installed. For information on how to install NSSF, see the OCNSSF Cloud Native Installation Guide.

To Configure NSSF using REST APIs:

1. Configure the NSI-Profile managed object: NSI-Profile consists of network slice name and ID and NRF-ID ,Target AMF lists which are associated to the slice.
   • Request_Type: POST
   • URL: http://{apiRoot}/nssf-configuration/v1/nsiprofiles
   • Body : Refer to Sample NSI-Profile-Body section for sample message/s and OpenApi for schema.

   REST message sample - NSI Profiles

   https://host:port/v1/nssf/configurations/nsiprofiles
   POST
   Content-Type: application/json
   BODY
   {
       "name": "NSI001",
       "nrfUri": "https://nrf.oracle.com",
       "nsiId": "1",
       "targetAmfSets": 
       [
           {
               "regionId": "01",
               "setId": "001",
               "setFqdn": "set001.region01.amfset.5gc.mnc311.mcc282.3gppnetwork.org"
           },
           {
               "regionId": "01",
               "setId": "002",
               "setFqdn": "set002.region01.amfset.5gc.mnc311.mcc282.3gppnetwork.org"
           }
       ]
   }

2. Configure the NSS Rule managed object: NSS Rules are policy rules which enable operator to ALLOW/REJECT a request for Network Slice Selection request and If allowed then map to a Network Slice.
   • Request_Type: POST
   • URL: http://{apiRoot}/nssf-configuration/v1/nssrules
   • Body : Refer to Sample NSS-Rule -Body section for sample message/s and OpenApi for schema.

   REST message sample - NSS Rules

   https://host:port/v1/nssf/configurations/nssrules
   POST
   Content-Type: application/json
   BODY
   {
       "name": "NSSRULE01",
       "amfId": "1",
       "plmnId":
       {
           "mcc": "311",
           "mnc": "282",
       },
       "tac": "123",
       "snssai": 
       {
           "sst": "1",
           "sd": "ABCDEF"
       },
       "salience": "0",
       "behavior":
       {
           "grant": "ALLOWED",
           "accessType": "3GPP_ACCESS",
           "nsiProfiles": 
           [
               {
                   "name": "NSI001",
                   "salience": 1
               },
               {
                   "name": "NSI002",
                   "salience": 0
               }
           ]
       }
   }

3. Configure the Configured NSSAI managed object: Configured NSSAI enables customer to configure default configures NSSAI based on one or more of the following parameters PLMN, TAC, AMF-ID .
   • Request_Type: POST
   • URL: http://{apiRoot}/nssf-configuration/v1/configuredsnssais
   • Body : Refer to Sample Configured-NSSAI-Body section for sample message/s and OpenApi for schema.

   REST message sample - AMF Resolutions

   https://host:port/v1/nssf/configurations/amfresolutions
   POST
   Content-Type: application/json
   BODY
   {
       "regionId": "1",
       "setId": "1",
       "candidateAmfList":
       [
           {
               "fqdn": "pt01.set001.region01.amfset.5gc.mnc311.mcc282.3gppnetwork.org",
               "instanceId": "ABCDEF"
           },
           {
               "fqdn": "pt02.set001.region01.amfset.5gc.mnc311.mcc282.3gppnetwork.org",
               "instanceId": "ABCDEG"
           }
       ]
   }

4. Configure the AMF Resolution managed object: AMF Resolution enables customer to configure mapping candidate amf list to a Target AMF set ID and Region ID.
   • Request_Type: POST
   • URL: http://{apiRoot}/nssf-configuration/v1/amfresolutions
   • Body : Refer to Sample AMF Resolution-Body section for sample message/s and OpenApi for schema.

   REST message sample - Configured NSSAIs

   https://host:port/v1/nssf/configurations/configuredsnssais
   POST
   Content-Type: application/json
   BODY
   {
       "amfId": "1",
       "plmn":
       {
           "mcc": "1",
           "mnc": "1",
       },
       "tac": "1",
       "salience": 0
       "nssai":
       [
           {
               "sst": 1,
               "sd": "ABC"
           },
           {
               "sst": 2,
               "sd": "DEF"
           }
       ]
   }

For more information on APIs and managed object parameters, see Managed Objects.