Managed Objects

The following NSSF managed objects can be configured using REST APIs :

NSI Profile: The NSI Profile managed object enables customer to configure Network Slice Instance profile. This allows customer to create an Network Slice , by providing a name ,id, NRF url corresponding to the slice and list of Target AMF sets which support this slice.

Table 5-1 NSI Profile - Parameters

S.No Field Name Type Description (With Default Values)
1 name String Network Slice Instance Profile Name.
2 nrfUri String URI of the Network Resource Function
3 nsiId String Network Slice Intance Identifier
4 targetAmfSets array (TargetAmfSet) array of TargetAmfSet (Refer primitive data type section)

Customer can configure NSI Profiles by following the information provided in the table below. The supported operations are POST, GET, DELETE, and PUT. The following table provides information about the REST APIs supported by the NSI Profile managed object.

Table 5-2 Supported REST APIs - NSI Profile

Resource Name URI Data Type HTTP Method Description
NSI Profiles /nssf-configuration/v1/nsiprofiles array(NssfNsiProfile) POST Create a network slice instance profile
GET Read all network slice instance profiles
NSI Profile /nssf-configuration/v1/nsiprofiles/{name} NsiProfile GET Read a network slice instance profile
DELETE Delete a network slice instance profile
PUT Update a network slice instance profile

NSS Rule: The NSS Rule managed object enables customer to configure policy rules, NSS Rule allows customer to allow/reject/associate a Network slice based on NSSAI(SST and SD) , PLMN(MCC and MNC) ,TAC , AMF_ID. Operator can configure salience value to prioritize one rule over other.

Table 5-3 NSS Rule Parameters

S.No Field Name Type Description (With Default Values)
1 name String Network Slice Selection Rule Name
2 amfId String AMF Identifier
3 plmnId String Public Land Mobile Network ID (MCC:MNC)
4 tac String Tracking Area Code
5 snssai Snssai Single Network Slice Selection Assistance Information
6 salience Integer Order of importance, higher salience, more important
7 behaviour Behaviour

Customer can configure NSS Rules by following the information provided in the table below. The supported operations are POST, GET, DELETE, and PUT. The following table provides information about the REST APIs supported by the NSS Rule managed object.

Table 5-4 Supported REST APIs - NSS Rule

Resource Name URI Data Type HTTP Method Description
NSS Rules /nssf-configuration/v1/nssrules array(NssfNssRule) POST Create a network slice selection rule
GET Read all network slice selection rules
NSS Rule /nssf-configuration/v1/nssrules/{name} NssRule GET Read a network slice selection rule
DELETE Delete a network slice selection rule
PUT Update a network slice selection rule

TargetAmfSet

AMF Resolution: The AMF Resolution managed object enables customer to configure mapping of list of candidate AMFs to a pair Target AMF set ID and Region ID. This enables operator to give static candidate AMF list. This configuration is used in cases where customer has disabled discovery service with NRF.

Table 5-5 AMF Resolution - Parameters

S.No Field Name Type Description (With Default Values)
1 regionId Integer Region ID of the target AMF list
2 setId Integer Set ID of the target AMF list
3 candidateAmfList array(candidateAmf) Refer the primitive data type section

Customer can configure AMF Resolution by following the information provided in the table below. The supported operations are POST, GET, DELETE, and PUT. The following table provides information about the REST APIs supported by the AMF Resolution managed object.

Table 5-6 Supported REST APIS - AMF Resolution

Resource Name URI Data Type HTTP Method Description
AMF Resolutions /nssf-configuration/v1/amfresolutions array(NssfAmfResolution) POST Create a AMF resolution
GET Read all AMF resolutions
AMF Resolution /nssf-configuration/v1/amfresoltuions/{region_id}[:{set_id}[:{instance_id}]] NssfAmfResolution GET Read a AMF resolution
DELETE Delete a AMF resolution
PUT Update a AMF resolution
Configured NSSAI: The Configured NSSAI managed object enables customer to configure default NSSAI based on one or more of the following parameters PLMN, TAC, AMF-ID. This enables operator to configure default behavior when none of the rules match and UE has set default indication flag to true.

Table 5-7 Configured NSSAI - Parameters

S.No Field Name Type Description (With Default Values)
1 amfId Integer AMF Identifier
2 plmnid plmn Public Land Mobile Network ID (MCC:MNC)
3 tac string Tracking Area Code
4 salience Integer Order of importance, higher salience, more important
5 snssai array(Snssai) Refer to primitive datatype section

Customer can configure Configured NSSAI by following the information provided in the table below. The supported operations are POST, GET, DELETE, and PUT. The following table provides information about the REST APIs supported by the Configured NSSAI managed object.

Table 5-8 Supported REST APIs - Configured NSSAI

Resource Name URI Data Type HTTP Method Description
Configured NSSAIs /nssf-configuration/v1/configurednssais array(NssfConfiguredNssai) POST Create a configured NSSAI
GET Read all configured NSSAIs
Configured NSSAI /nssf-configuration/v1/configurednssais/{amf_id}:{mcc}:{mnc}[:{tac}[:{sst}:{sd}]]] NssfConfiguredNssai GET Read a configured NSSAI
DELETE Delete a configured NSSAI
Time Profile: The Time Profile managed object enables customer to configure time/date based slice selection policies. This allows customer to create a "Time Profile" and associate it to a network slice when creating a "NSS Rule" managed object.

Table 5-9 TimeProfile - Parameters

S.No Field Name Type Description
1 name String Time Profile Name
2 startDate Date Date in the format of yy-mm-dd
3 endDate Date Date in the format of yy-mm-dd
4 daysOfWeek array(Daysofweek) Refer enumeration section
5 timespans array(TimeSpan) Refer primitive section

Customer can configure Time Profiles by following the information provided in the table below. The supported operations are POST, GET, DELETE, and PUT. The following table provides information about the REST APIs supported by the Time Profile managed object.

Table 5-10 Supported REST APIs - Time Profile

Resource Name URI Data Type HTTP Method Description
Time Profiles /nssf-configuration/v1/timeprofiles array(TimeProfile) POST Create a time profile
GET Read all time profiles
Time Profile /nssf-configuration/v1/timeprofiles TimeProfile GET Read a time profile
DELETE Delete a time profile
PUT Update a time profile
Auth NSSAI: The Auth NSSAI managed object enables customer to configure network slice authentication rules by configuring Grant status (Allowed/Rejected_PLMN, Rejected_TAC) for S-Nssai on a per TAI basis.

Table 5-11 Auth NSSAI - Parameters

S.No Field Name Type Description (With Default Values)
1 name String Network Slice Authentication Rule Name
2 plmnId plmnid Public Land Mobile Network ID (MCC:MNC)
3 tac string Tracking Area Code
4 snssai Snssai Single Network Slice Selection Assistance Information
5 grant Grant Whether the requested s-NSSAI is allowed or restricted

Customer can configure Auth NSSAI by following the information provided in the table below. The supported operations are POST, GET, and DELETE. The following table provides information about the REST APIs supported by the Auth NSSAI managed object.

Table 5-12 Supported REST APIs - Auth NSSAI

Resource Name URI Data Type HTTP Method Description
AuthNSSAIs /nssf-configuration/v1/authNSSAI array(AuthNSSAI) POST Create a AuthNSSAI Profile
GET Read all AuthNSSAI Profiles
AuthNSSAI

/nssf-configuration/v1/authNSSAI

/ {mcc}:{mnc}[:{tac}[:{sst}:{sd}]]
AuthNSSAI GET Read a AuthNSSAI Profile
DELETE Delete a AuthNSSAI Profile

For a sample Open API Specification, see Open API Specification.

Primitive Tables

Behavior

Attribute Datatype Description
accessType AccessType Refer Enumeration section
nsiProfiles array(NsiProfileMap) Array of NsiProfile Map
Attribute Datatype Description
regionId string region id of TargetAmfSet
setId string set id of TargetAmfSet
setFqdn string FQDN of TargetAmfSet

CandidateAmf

Attribute Datatype Description
fqdn string FQDN of targetamfset
instanceId string Instance id of Amf

Timespan

Attribute Datatype Description
startTime time start time in hh:mm:ss
endTime time end time in hh:mm:ss

Plmnid

Attribute Datatype Description
mcc string Mobile Country Code
mnc string Mobile Network Code

Snssai

Attribute Datatype Description
sst integer Slice /Service Type
sd string Slice Differentiator

Enumerations

Grant

Value Description
"ALLOWED" Allowed signifies SNSSAI is allowed in TAI
"REJECTED_IN_TA" S-NSSAI is not allowed for Tracking Area
"REJECTED_IN_PLMN S-NSSAI is not allowed for PLMN

Access Type

Value Description
"3GPP_ACCESS" Specifies 5G network
"NON_3GPP_ACCESS" Specifies non 5G network

DayofWeek

Value Description
"MONDAY" Monday, day of the week
"TUESDAY" Tuesday, day of the week
"WEDNESDAY" Wednesday, day of the week
"THURSDAY" Thursday, day of the week
"FRIDAY" Friday, day of the week
"SATURDAY" Saturday, day of the week
"SUNDAY" Sunday, day of the week