The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Clears subscriber session information.
Exec
clear subscriber [ imsi imsi | msisdn msisdn ] Specify the IMSI.
Must be a string.
Specify the MSISDN.
Must be a string.
Use this command to clear subscriber session information.
Configures the cluster name and unified API external IP parameters.
Exec > Global Configuration
deployment add config { cluster-name cluster_name | port port_number | unified-api-external-ip ip_address} Specify the cluster name.
Must be a string.
Specify the port number of the unified API service.
Specify the external IP address of the unified API service.
Use this command to configure the cluster name and unified API external IP parameters.
Removes the deployment configuration file.
Exec
deployment remove-config Use this command to remove the deployment configuration file.
Displays configuration information.
Exec
deployment show-config Use this command to view the configuration information.
Configures the NF management group parameters.
Exec > Global Configuration
group nf-mgmt group_name nrf-mgmt-group registerGroup { nrf-mgmt-group mgmt_group_name | api-version api_version | locality group_locality} Specify the NF Management Service API version supported by the NRF.
Must be one of the following:
1.0.0
1.0.2
Default Value: 1.0.0.
Specify to enable or disable sending cluster load in NRF heartbeat requests.
Must be one of the following:
false
true
Default Value: true.
Specify the NRF group locality.
Must be a string.
Specify the NRF management group name.
Specify the group name.
Must be a string.
Use this command to enter the NRF management group configuration.
Configures the failover SLA parameters.
Exec > Global Configuration
failover group nf-mgmt group_name failover sla failover_sla Specify the failover SLA value in milliseconds.
Must be an integer.
Use this command to configure the failover SLA parameters.
Configures the reconnect interval.
Exec > Global Configuration
reconnect interval reconnect_interval Specify the reconnect interval in milliseconds.
Must be an integer.
Use this command to configure the reconnect interval.
Configures NRF discovery group parameters.
group nrf discovery group_name Specify the discovery group name.
Must be a string.
Use this command to configure NRF discovery group parameters. Enters the NRF Discovery Configuration mode.
Configures the NRF discovery service type.
group nrf discovery group_name service type nrf nnrf-disc service_type Specify the NRF discovery service type.
Must be one of the following:
nnrf-disc
Use this command to configure the NRF discovery service type.
Configures the endpoint profile parameters.
Exec > Global Configuration
group nrf discovery discovery_group service type nrf nnrf-disc endpoint-profile endpoint_profile_name { capacity endpoint_capacity | priority endpoint_priority | api-uri-prefix api_uri_prefix | api-root api_string | api-root api_string | uri-scheme uri_scheme} Specify the deployment-specific service API prefix that is used within the { apiRoot }.
Must be a string.
Specify the API URI prefix. If not configured, it takes the standard API name for the service as per the specification.
Must be a string.
Specify the node capacity for the endpoint.
Must be an integer.
Default Value: 10.
Specify the alias name for client certificate.
Must be a string.
Specify the client certificate in PEM format.
Specify the client private key in PEM format.
Specify the endpoint profile name.
Must be a string.
Specify the endpoint's priority.
Must be an integer.
Default Value: 1.
Specify the URI scheme.
Must be one of the following:
http
https
Default Value: http.
Use this command to configure the endpoint profile parameters.
Configures endpoint name.
Exec > Global Configuration
group nrf discovery discovery_group service type nrf nnrf-disc endpoint-profile endpoint_profile_name { priority endpoint_priority | capacity endpoint_capacity} Specify the node capacity for the endpoint.
Must be an integer.
Specify the endpoint name.
Must be a string.
Specify the priority for the service to select the appropriate profile using the load-balancing logic.
Must be an integer.
Use this command to configure the endpoint name.
Configures the IP address and port parameters.
Exec > Global Configuration
group nrf discovery discovery_group service type nrf nnrf-disc endpoint-profile endpoint_profile endpoint-name endpoint_name { primary ip-address [ ipv4 ipv4_address | ipv6 ipv6_address | port port_number ] | secondary ip-address [ ipv4 ipv4_address | ipv6 ipv6_address | port port_number ] | tertiary ip-address [ ipv4 ipv4_address | ipv6 ipv6_address | port port_number ]} Specify the fully qualified domain name.
Must be a string.
Specify the IPv4 address.
Specify the IPv6 address.
Specify the fully qualified domain name.
Must be a string.
Specify the IPv4 address.
Specify the IPv6 address.
Specify the port number.
Use this command to configure the IP address and port parameters.
Configures the IP address and port parameters.
Exec > Global Configuration
group nrf discovery discovery_group service type nrf nnrf-disc endpoint-profile endpoint_profile endpoint-name endpoint_name { primary ip-address [ ipv4 ipv4_address | ipv6 ipv6_address | port port_number ] | secondary ip-address [ ipv4 ipv4_address | ipv6 ipv6_address | port port_number ] | tertiary ip-address [ ipv4 ipv4_address | ipv6 ipv6_address | port port_number ]} Specify the fully qualified domain name.
Must be a string.
Specify the IPv4 address.
Specify the IPv6 address.
Specify the fully qualified domain name.
Must be a string.
Specify the IPv4 address.
Specify the IPv6 address.
Specify the port number.
Use this command to configure the IP address and port parameters.
Configures the IP address and port parameters.
Exec > Global Configuration
group nrf discovery discovery_group service type nrf nnrf-disc endpoint-profile endpoint_profile endpoint-name endpoint_name { primary ip-address [ ipv4 ipv4_address | ipv6 ipv6_address | port port_number ] | secondary ip-address [ ipv4 ipv4_address | ipv6 ipv6_address | port port_number ] | tertiary ip-address [ ipv4 ipv4_address | ipv6 ipv6_address | port port_number ]} Specify the fully qualified domain name.
Must be a string.
Specify the IPv4 address.
Specify the IPv6 address.
Specify the fully qualified domain name.
Must be a string.
Specify the IPv4 address.
Specify the IPv6 address.
Specify the port number.
Use this command to configure the IP address and port parameters.
Configures the URI version.
Exec > Global Configuration
group nrf discovery discovery_group service type nrf nnrf-disc endpoint-profile endpoint_profile_name version uri_version full-version full_version Specify the full URI version in the format major-version .minor-version .patch-version .[alpha-draft-number ].
Must be a string.
Specify the URI version.
Must be a string in the pattern v\d.
Use this command to configure the URI version.
Configures the NRF management group parameters.
group nrf mgmt mgmt_group_name Specify the management group name.
Must be a string.
Use this command to configure the NRF management group parameters.
Configures the NRF management service type.
group nrf mgmt group_name service type nrf service_name Specify the service name.
Must be one of the following:
nnrf-nfm
Use this command to configure the NRF management service type.
Configures the endpoint profile parameters.
Exec > Global Configuration
group nrf discovery discovery_group service type nrf nnrf-disc endpoint-profile endpoint_profile_name { capacity endpoint_capacity | priority endpoint_priority | api-uri-prefix api_uri_prefix | api-root api_string | api-root api_string | uri-scheme uri_scheme} Specify the deployment-specific service API prefix that is used within the { apiRoot }.
Must be a string.
Specify the API URI prefix. If not configured, it takes the standard API name for the service as per the specification.
Must be a string.
Specify the node capacity for the endpoint.
Must be an integer.
Default Value: 10.
Specify the alias name for client certificate.
Must be a string.
Specify the client certificate in PEM format.
Specify the client private key in PEM format.
Specify the endpoint profile name.
Must be a string.
Specify the endpoint's priority.
Must be an integer.
Default Value: 1.
Specify the URI scheme.
Must be one of the following:
http
https
Default Value: http.
Use this command to configure the endpoint profile parameters.
Configures endpoint name.
Exec > Global Configuration
group nrf discovery discovery_group service type nrf nnrf-disc endpoint-profile endpoint_profile_name { priority endpoint_priority | capacity endpoint_capacity} Specify the node capacity for the endpoint.
Must be an integer.
Specify the endpoint name.
Must be a string.
Specify the priority for the service to select the appropriate profile using the load-balancing logic.
Must be an integer.
Use this command to configure the endpoint name.
Configures the IP address and port parameters.
Exec > Global Configuration
group nrf discovery discovery_group service type nrf nnrf-disc endpoint-profile endpoint_profile endpoint-name endpoint_name { primary ip-address [ ipv4 ipv4_address | ipv6 ipv6_address | port port_number ] | secondary ip-address [ ipv4 ipv4_address | ipv6 ipv6_address | port port_number ] | tertiary ip-address [ ipv4 ipv4_address | ipv6 ipv6_address | port port_number ]} Specify the fully qualified domain name.
Must be a string.
Specify the IPv4 address.
Specify the IPv6 address.
Specify the fully qualified domain name.
Must be a string.
Specify the IPv4 address.
Specify the IPv6 address.
Specify the port number.
Use this command to configure the IP address and port parameters.
Configures the IP address and port parameters.
Exec > Global Configuration
group nrf discovery discovery_group service type nrf nnrf-disc endpoint-profile endpoint_profile endpoint-name endpoint_name { primary ip-address [ ipv4 ipv4_address | ipv6 ipv6_address | port port_number ] | secondary ip-address [ ipv4 ipv4_address | ipv6 ipv6_address | port port_number ] | tertiary ip-address [ ipv4 ipv4_address | ipv6 ipv6_address | port port_number ]} Specify the fully qualified domain name.
Must be a string.
Specify the IPv4 address.
Specify the IPv6 address.
Specify the fully qualified domain name.
Must be a string.
Specify the IPv4 address.
Specify the IPv6 address.
Specify the port number.
Use this command to configure the IP address and port parameters.
Configures the IP address and port parameters.
Exec > Global Configuration
group nrf discovery discovery_group service type nrf nnrf-disc endpoint-profile endpoint_profile endpoint-name endpoint_name { primary ip-address [ ipv4 ipv4_address | ipv6 ipv6_address | port port_number ] | secondary ip-address [ ipv4 ipv4_address | ipv6 ipv6_address | port port_number ] | tertiary ip-address [ ipv4 ipv4_address | ipv6 ipv6_address | port port_number ]} Specify the fully qualified domain name.
Must be a string.
Specify the IPv4 address.
Specify the IPv6 address.
Specify the fully qualified domain name.
Must be a string.
Specify the IPv4 address.
Specify the IPv6 address.
Specify the port number.
Use this command to configure the IP address and port parameters.
Configures the URI version.
Exec > Global Configuration
group nrf discovery discovery_group service type nrf nnrf-disc endpoint-profile endpoint_profile_name version uri_version full-version full_version Specify the full URI version in the format major-version .minor-version .patch-version .[alpha-draft-number ].
Must be a string.
Specify the URI version.
Must be a string in the pattern v\d.
Use this command to configure the URI version.
Configures the BSF profile parameters.
Exec > Global Configuration
profile nf-client nf-type bsf bsf-profile bsf_profile Specify the BSF profile name.
Must be a string.
Use this command to configure the BSF profile parameters.
Configures the locality parameters.
Exec > Global Configuration
nf-client nf-type bsf profile nf-client nf-type bsf bsh-profile bsf_profile locality locality Specify the locality priority.
Must be an integer.
Default Value: 65535.
Specify the locality name.
Must be a string.
Use this command to configure the locality parameters.
Configures the BSF service type.
Exec > Global Configuration
profile nf-client nf-type bsf chf-profile profile_name locality locality { priority priority | service service_name type service_type} Specify the service type.
Must be one of the following:
nbsf-management
Use this command to configure the BSF service type.
Configures the endpoint profile parameters.
Exec > Global Configuration
group nrf discovery discovery_group service type nrf nnrf-disc endpoint-profile endpoint_profile_name { capacity endpoint_capacity | priority endpoint_priority | api-uri-prefix api_uri_prefix | api-root api_string | api-root api_string | uri-scheme uri_scheme} Specify the deployment-specific service API prefix that is used within the { apiRoot }.
Must be a string.
Specify the API URI prefix. If not configured, it takes the standard API name for the service as per the specification.
Must be a string.
Specify the node capacity for the endpoint.
Must be an integer.
Default Value: 10.
Specify the alias name for client certificate.
Must be a string.
Specify the client certificate in PEM format.
Specify the client private key in PEM format.
Specify the endpoint profile name.
Must be a string.
Specify the endpoint's priority.
Must be an integer.
Default Value: 1.
Specify the URI scheme.
Must be one of the following:
http
https
Default Value: http.
Use this command to configure the endpoint profile parameters.
Configures endpoint name.
Exec > Global Configuration
group nrf discovery discovery_group service type nrf nnrf-disc endpoint-profile endpoint_profile_name { priority endpoint_priority | capacity endpoint_capacity} Specify the node capacity for the endpoint.
Must be an integer.
Specify the endpoint name.
Must be a string.
Specify the priority for the service to select the appropriate profile using the load-balancing logic.
Must be an integer.
Use this command to configure the endpoint name.
Configures the URI version.
Exec > Global Configuration
group nrf discovery discovery_group service type nrf nnrf-disc endpoint-profile endpoint_profile_name version uri_version full-version full_version Specify the full URI version in the format major-version .minor-version .patch-version .[alpha-draft-number ].
Must be a string.
Specify the URI version.
Must be a string in the pattern v\d.
Use this command to configure the URI version.
Configures the locality for the UDR profile.
profile nf-client nf-type chf chf-profile chf_profile Specify the CHF profile name.
Must be a string.
Use this command to configure the locality for the CHF profile.
Configures the locality for the CHF profile.
nf-client nf-type chf profile nf-client nf-type chf chf-profile chf_profile locality locality Specify the priority for the CHF local configuration."
Must be an integer.
Default Value: 65535.
Specify the locality name.
Must be a string.
Use this command to configure the locality for the CHF profile.
Configures the CHF service type.
Exec > Global Configuration
profile nf-client nf-type chf chf-profile profile_name locality locality { priority priority | service service_name type service_type} Specify the CHF service type.
Must be one of the following:
nchf-spendinglimitcontrol
Use this command to configure the CHF service type.
Configures the endpoint profile parameters.
Exec > Global Configuration
group nrf discovery discovery_group service type nrf nnrf-disc endpoint-profile endpoint_profile_name { capacity endpoint_capacity | priority endpoint_priority | api-uri-prefix api_uri_prefix | api-root api_string | api-root api_string | uri-scheme uri_scheme} Specify the deployment-specific service API prefix that is used within the { apiRoot }.
Must be a string.
Specify the API URI prefix. If not configured, it takes the standard API name for the service as per the specification.
Must be a string.
Specify the node capacity for the endpoint.
Must be an integer.
Default Value: 10.
Specify the alias name for client certificate.
Must be a string.
Specify the client certificate in PEM format.
Specify the client private key in PEM format.
Specify the endpoint profile name.
Must be a string.
Specify the endpoint's priority.
Must be an integer.
Default Value: 1.
Specify the URI scheme.
Must be one of the following:
http
https
Default Value: http.
Use this command to configure the endpoint profile parameters.
Configures endpoint name.
Exec > Global Configuration
group nrf discovery discovery_group service type nrf nnrf-disc endpoint-profile endpoint_profile_name { priority endpoint_priority | capacity endpoint_capacity} Specify the node capacity for the endpoint.
Must be an integer.
Specify the endpoint name.
Must be a string.
Specify the priority for the service to select the appropriate profile using the load-balancing logic.
Must be an integer.
Use this command to configure the endpoint name.
Configures the URI version.
Exec > Global Configuration
group nrf discovery discovery_group service type nrf nnrf-disc endpoint-profile endpoint_profile_name version uri_version full-version full_version Specify the full URI version in the format major-version .minor-version .patch-version .[alpha-draft-number ].
Must be a string.
Specify the URI version.
Must be a string in the pattern v\d.
Use this command to configure the URI version.
Configures the locality for the UDR profile.
profile nf-client nf-type udr udr-profile udr_profile locality locality [ priority priority | service udr_service ] Specify the priority for the UDR local configuration."
Must be an integer.
Specify the UDR profile name."
Must be a string.
Use this command to configure the locality for the UDR profile.
Configures UDR service type.
Exec > Global Configuration
profile nf-client nf-type udr udr-profile profile_name locality locality { priority priority | service service_name type service_type} Specify the service type.
Must be one of the following:
nudr-dr
Use this command to configure the UDR service type.
Configures the NF type for the NF client pair configuration.
profile nf-pair nf-type nf_type nrf-discovery-group group_name { subscription-enabled { false | true } | subscription-enabled { false | true } | subscription-extension extension_duration} Specifiy the NRF discovery group name.
Specifiy to enable or disable the subscription to NRF for NF change.
Must be one of the following:
false
true
Default Value: false.
Specify the duration for which the subscription must be extended in minutes.
Must be an integer.
Default Value: 60.
Specifiy the NF type.
Must be one of the following:
BSF
CHF
UDR
Use this command to configure the NF type for the NF client pair configuration.
Configures the locality parameters.
Exec > Global Configuration
profile nf-pair nf-type nf_type nrf-discovery-group group_name locality [ client client_locality | preferred-server preferred_server | geo-server geo_server ] Specify the locality of the client.
Specify the geo-server locality information.
Must be a string.
Specify the preferred server locality information.
Must be a string.
Use this command to configure the locality parameters.
Configures the network function profile parameters to enable discovery of the registered NFs, and when the discovery fails, the discovery is attempted on the local configuration.
Exec > Global Configuration
service-registration profile { allowed-plmns { mobile_country_code | mobile_network_code } | capacity profile_capacity | instance-id instance_id_pcf | locality pcf_location | nf-status nf_service_status | pcf-info { dnn-list | supi-ranges } | plmn-list { mobile_country_code | mobile_network_code } | priority profile_priority | snssais { slice_service_type | sd service_differentiator }} Specify the PCFs profile's capacity.
Must be an integer.
Specify the fully qualified domain name of the PCF. For example, pcf.5gc.mnc123.mcc089.pub.3gppnetwork.org.
Must be a string.
Specify the PCF instance ID.
Must be a string.
Specify the location of the PCF.
Must be a string.
Specify the PCFs profile's capacity.
Must be an integer.
Specify the fully qualified domain name of the PCF. For example, pcf.5gc.mnc123.mcc089.pub.3gppnetwork.org.
Must be a string.
Specify the PCF instance ID.
Must be a string.
Specify the location of the PCF.
Must be a string.
Specify the PCF profile's priority.
Must be an integer.
Specify the PCF service status.
Must be one of the following:
REGISTERED
UNDISCOVERABLE
Default Value: REGISTERED.
Use this command to configure the network function profile.
Configures PLMNs allowed to access the network function.
Exec > Global Configuration
service-registration profile allowed-plmns { mobile_country_code | mobile_network_code} Specify the Mobile Country Code.
Must be a string in the pattern \d{3}.
Specify the Mobile Network Code.
Must be a string in the pattern \d{2,3}.
Use this command to configure PLMNs allowed to access the network function.
Configures the PCF parameters.
Exec > Global Configuration
service-registration profile pcf-info { dnn-list dnn_list_name | supi-ranges supi_range_id [ start start_value | pattern range_pattern | end end_value ]} Specify the DNNs supported by the PCF.
Must be a string.
Use this command to configure PCF parameters.
Configures the list of SUPI ranges, which the PCF instance serves.
Exec > Global Configuration
service-registration profile pcf-info supi-ranges supi_range_id [ start start_value | pattern range_pattern | end end_value ] Specify the last value of the SUPI range.
Must be a string in the pattern [0-9]+.
Specify the regular expression according to the ECMA-262 dialect that represents the set of SUPIs belonging to the specified range.
Must be a string.
Specify the first value of the SUPI range.
Must be a string in the pattern [0-9]+.
Specify the SUPI range identifier.
Must be a string.
Use this command to configure the list of SUPI ranges, which the PCF instance serves.
Configures the PLMNs of the network function.
Exec > Global Configuration
service-registration profile plmn-list { mobile_country_code | mobile_network_code} Specify the Mobile Country Code.
Must be a string in the pattern \d{3}.
Specify the Mobile Network Code.
Must be a string in the pattern \d{2,3}.
Use this command to configure the PLMNs of the network function.
Configures the S-NSSAIs of the network function.
Exec > Global Configuration
service-registration profile snssais { slice_service_type | sd service_differentiator} Specify the Slice Differentiator value.
Must be a string.
Specify the Slice or Service Types value.
Must be an integer in the range of 0-255.
Use this command to configure the S-NSSAIs of the network function.
Configures the service parameters.
Exec > Global Configuration
service-registration services services_name Specify the API version.
Must be one of the following:
1.0.0
1.0.2
Default Value: 1.0.0.
Specify the service name.
Must be one of the following:
amfService
smfService
Use this command to configure the service parameters.
Exec > Global Configuration
service-registration services service_name allowed-nssais { slice_service_type | sd service_differentiator} Specify the Slice Differentiator value.
Must be a string.
Specify the Slice or Service Types value.
Must be an integer in the range of 0-255.
Use this command to configure the S-NSSAIs allowed of the NF service instance.
Configures the PLMNs allowed to access the NF service instance.
Exec > Global Configuration
service-registration services service_name allowed-plmns { mobile_country_code | mobile_network_code} Specify the Mobile Country Code.
Must be a string in the pattern \d{3}.
Specify the Mobile Network Code.
Must be a string in the pattern \d{2,3}.
Use this command to configure the PLMNs allowed to access the NF service instance.
Displays subscriber session information.
Exec
show subscriber [ imsi imsi | msisdn msisdn ] Specify the IMSI.
Must be a string.
Specify the MSISDN.
Must be a string.
Use this command to view subscriber session information.
Feedback