SMF NRF CLI Commands

group nf-mgmt

Configures NF management group name.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

nf-mgmt mgmt_group_name { nrf-mgmt-group nrf_mgmt_group_name | nrf-auth-group nrf_auth_group_name | locality locality_name | re-register { false | true } }

mgmt_group_name

Specify the NRF management group name.

Must be a string.

nrf-mgmt-group nrf_mgmt_group_name

Specify the NRF management group name.

Must be a string.

locality locality_name

Specify locality information.

Must be a string.

Usage Guidelines

Use this command to configure NF management group name.

group nf-mgmt failover

Configures failover SLA time duration.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

failover sla failover_sla

sla failover_sla

Specify the failover sla time duration in milliseconds.

Must be an integer.

Usage Guidelines

Use this command to configure the failover SLA time duration.

group nf-mgmt heartbeat

Configures heartbeat interval time in seconds.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

heartbeat interval heartbeat_interval

interval heartbeat_interval

Specify the heartbeat interval time in seconds.

Must be an integer.

Usage Guidelines

Use this command to configure the heartbeat interval time in seconds.

group nf-mgmt reconnect

Configures reconnect interval configuration.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

reconnect interval reconnect_interval

interval reconnect_interval

Specify the reconnect interval time in milliseconds.

Must be an integer.

Usage Guidelines

Use this command to configure reconnect interval time in milliseconds.

group nrf auth

Configures NRF auth group parameters.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

auth group_name [ nrf-type nrf_type ]

group_name

Specify the NRF auth group name.

Must be a string.

nrf-type nrf_type

Specify the NRF type.

Must be one of the following:

  • PLMN: PLMN.

  • SHARED: SHARED.

  • SLICE-LOCAL: SLICE-LOCAL.

Usage Guidelines

Use this command to configure NRF auth group parameters.

group nrf auth service type nrf

Configures NRF service auth name.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

nrf nrf-service-name nrf_service_auth_name

nrf-service-name nrf_service_auth_name

Specify the NRF service auth name.

Must be one of the following:

  • oauth2

Usage Guidelines

Use this command to configure the NRF service auth name.

group nrf auth service type nrf endpoint-profile

Configures endpoint profile parameters.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

endpoint-profile endpoint_profile_name { capacity capacity_value | priority priority_value | api-uri-prefix api_uri_prefix | api-root api_root | uri-scheme uri_scheme }

endpoint_profile_name

Specify the endpoint profile name.

Must be a string.

capacity capacity_value

Specify the profile capacity.

Must be an integer in the range of 0-65535.

Default Value: 10.

priority priority_value

Specify the profile priority.

Must be an integer in the range of 0-65535.

Default Value: 1.

api-uri-prefix api_uri_prefix

Specify the API URI prefix.

Must be a string.

api-root api_root

Specify the API root.

Must be a string.

uri-scheme uri_scheme

Specify the URI scheme.

Must be one of the following:

  • http: HTTP.

  • https: HTTPS.

Usage Guidelines

Use this command to configure endpoint profile parameters.

group nrf auth service type nrf endpoint-profile endpoint-name

Configures the endpoint name.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

endpoint-name endpoint_name [ priority priority_value | capacity capacity_value ]

endpoint_name

Specify the endpoint name. You can configure the primary, secondary, and tertiary host (IP: Port) within each endpoint for NF server failover handling. The server failover configuration accepts both the IPv4 and IPv6 addresses. However, the SMF gives preference to the IPv4 address.

Must be a string.

priority priority_value

Specify the node priority for endpoint.

Must be an integer in the range of 0-65535.

capacity capacity_value

Specify the node capacity.

Must be an integer in the range of 0-65535.

Usage Guidelines

Use this configuration to configure the endpoint name.

group nrf auth service type nrf endpoint-profile endpoint-name primary ip-address

Configures the endpoint IP address and port number.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

ip-address { { ipv4 ipv4_address | ipv6 ipv6_address } | port port_number }

port port_number

Specify the port number.

Must be an integer in the range of 0-65535.

Usage Guidelines

Use this command to configure the endpoint IP address and port number.

group nrf auth service type nrf endpoint-profile endpoint-name secondary ip-address

Configures the endpoint IP address and port number.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

ip-address { { ipv4 ipv4_address | ipv6 ipv6_address } | port port_number }

port port_number

Specify the port number.

Must be an integer in the range of 0-65535.

Usage Guidelines

Use this command to configure the endpoint IP address and port number.

group nrf auth service type nrf endpoint-profile endpoint-name tertiary ip-address

Configures the endpoint IP address and port number.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

ip-address { { ipv4 ipv4_address | ipv6 ipv6_address } | port port_number }

port port_number

Specify the port number.

Must be an integer in the range of 0-65535.

Usage Guidelines

Use this command to configure the endpoint IP address and port number.

group nrf auth service type nrf endpoint-profile version uri-version

Configures the URI version.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration > UDM NF-Client Profile Configuration > UDM Profile Configuration > Locality Configuration > UDM Service Name Type Configuration > Endpoint Profile Configuration > Version Configuration > URL Version Configuration

Syntax

version uri-version { uri_version | full-version full_version }

uri_version

Specify the URI version.

Must be a string in the pattern v\d.

full-version full_version

Specify the full version in the format major-version .minor-version .patch-version .[alpha-draft-number ]

Must be a string.

Usage Guidelines

Use this command to configure the URI version information.

group nrf discovery

Configures NRF discovery group parameters.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

discovery group_name [ nrf-type nrf_type ]

group_name

Specify the NRF discovery group name.

Must be a string.

nrf-type nrf_type

Specify the NRF type.

Must be one of the following:

  • PLMN: PLMN.

  • SHARED: SHARED.

  • SLICE-LOCAL: SLICE-LOCAL.

Usage Guidelines

Use this command to configure the NRF discovery group configuration.

group nrf discovery service type nrf

Configures the NRF discovery service name.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

nrf nrf_service_name [ responsetimeout response_timeout ]

nrf_service_name

Specify the NRF discovery service name.

Must be one of the following:

  • nnrf-disc

responsetimeout response_timeout

Specify the response timeout interval in milliseconds.

Must be an integer.

Default Value: 2000.

Usage Guidelines

Use this command to configure the NRF discovery service name.

group nrf discovery service type nrf endpoint-profile

Configures endpoint profile parameters.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

endpoint-profile endpoint_profile_name { api-uri-prefix api_uri_prefix | api-root api_root | uri-scheme uri_scheme }

api-uri-prefix api_uri_prefix

Specify the API URI prefix.

Must be a string.

endpoint_profile_name

Specify the endpoint profile name.

Must be a string.

api-root api_root

Specify the API root.

Must be a string.

uri-scheme uri_scheme

Specify the URI scheme.

Must be one of the following:

  • http

  • https

Usage Guidelines

Use this command to configure endpoint profile parameters.

group nrf discovery service type nrf endpoint-profile endpoint-name

Configures endpoint parameters.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

endpoint-name endpoint_name [ priority priority | capacity endpoint_capacity ]

endpoint_name

Specify the endpoint name.

Must be a string.

priority priority

Specify the node priority for endpoint.

Must be an integer in the range of 0-65535.

capacity endpoint_capacity

Specify the endpoint capacity.

Must be an integer in the range of 0-65535.

Default Value: 10.

Usage Guidelines

Use this command to configure endpoint parameters.

group nrf discovery service type nrf endpoint-profile endpoint-name primary ip-address

Configures the endpoint IP address and port number.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

ip-address { { ipv4 ipv4_address | ipv6 ipv6_address } | port port_number }

port port_number

Specify the port number.

Must be an integer in the range of 0-65535.

Usage Guidelines

Use this command to configure the endpoint IP address and port number.

group nrf discovery service type nrf endpoint-profile endpoint-name secondary ip-address

Configures the endpoint IP address and port number.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

ip-address { { ipv4 ipv4_address | ipv6 ipv6_address } | port port_number }

port port_number

Specify the port number.

Must be an integer in the range of 0-65535.

Usage Guidelines

Use this command to configure the endpoint IP address and port number.

group nrf discovery service type nrf endpoint-profile endpoint-name tertiary ip-address

Configures the endpoint IP address and port number.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

ip-address { { ipv4 ipv4_address | ipv6 ipv6_address } | port port_number }

port port_number

Specify the port number.

Must be an integer in the range of 0-65535.

Usage Guidelines

Use this command to configure the endpoint IP address and port number.

group nrf discovery service type nrf endpoint-profile version uri-version

Configures URI version information.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

uri-version uri_version [ full-version full_version ]

uri_version

Specify the URI version.

Must be a string in the pattern v\d.

full-version full_version

Specify the full version in the format major-version .minor-version .patch-version .[alpha-draft-number ]

Must be a string.

Usage Guidelines

Use this command to configure URI version information.

group nrf mgmt

Configures the NRF self-management group parameters.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

mgmt group_name [ nrf-type nrf_type ]

group_name

Specify the NRF self-management group name.

Must be a string.

nrf-type nrf_type

Specify the NRF type.

Must be one of the following:

  • PLMN: PLMN.

  • SHARED: SHARED.

  • SLICE-LOCAL: SLICE-LOCAL.

Usage Guidelines

Use this command to configure the NRF self-management group parameters.

group nrf mgmt service type nrf

Configures the NRF self-management service name.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

nrf nrf-service-name nrf_service_name [ responsetimeout response_timeout ]

nrf-service-name nrf_service_name

Specify the NRF service name.

Must be one of the following:

  • nnrf-nfm

responsetimeout response_timeout

Specify the response timeout interval in milliseconds.

Must be an integer.

Default Value: 2000.

Usage Guidelines

Use this command to configure the NRF self-management service name.

group nrf mgmt service type nrf endpoint-profile

Configures endpoint profile parameters.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

endpoint-profile endpoint_profile_name { api-uri-prefix api_uri_prefix | api-root api_root | uri-scheme uri_scheme }

api-uri-prefix api_uri_prefix

Specify the API URI prefix.

Must be a string.

endpoint_profile_name

Specify the endpoint profile name.

Must be a string.

api-root api_root

Specify the API root.

Must be a string.

uri-scheme uri_scheme

Specify the URI scheme.

Must be one of the following:

  • http

  • https

Usage Guidelines

Use this command to configure endpoint profile parameters.

group nrf mgmt service type nrf endpoint-profile endpoint-name

Configures the endpoint name.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

endpoint-name endpoint_name [ priority priority ]

endpoint_name

Specify the endpoint name.

Must be a string.

priority priority

Specify the node priority for endpoint.

Must be an integer in the range of 0-65535.

Usage Guidelines

Use this command to configure the endpoint name.

group nrf mgmt service type nrf endpoint-profile endpoint-name primary ip-address

Configures the endpoint IP address and port number.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

ip-address { { ipv4 ipv4_address | ipv6 ipv6_address } | port port_number }

ipv4 ipv4_address

Specify the IPv4 address.

Must be an IPv4 address.

ipv6 ipv6_address

Specify the IPv6 address.

Must be an IPv6 address.

port port_number

Specify the port number.

Must be an integer in the range of 0-65535.

Usage Guidelines

Use this command to configure the endpoint IP address and port number.

group nrf mgmt service type nrf endpoint-profile endpoint-name secondary ip-address

Configures the endpoint IP address and port number.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

ip-address { { ipv4 ipv4_address | ipv6 ipv6_address } | port port_number }

ipv4 ipv4_address

Specify the IPv4 address.

Must be an IPv4 address.

ipv6 ipv6_address

Specify the IPv6 address.

Must be an IPv6 address.

port port_number

Specify the port number.

Must be an integer in the range of 0-65535.

Usage Guidelines

Use this command to configure the endpoint IP address and port number.

group nrf mgmt service type nrf endpoint-profile endpoint-name tertiary ip-address

Configures the endpoint IP address and port number.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

ip-address { { ipv4 ipv4_address | ipv6 ipv6_address } | port port_number }

ipv4 ipv4_address

Specify the IPv4 address.

Must be an IPv4 address.

ipv6 ipv6_address

Specify the IPv6 address.

Must be an IPv6 address.

port port_number

Specify the port number.

Must be an integer in the range of 0-65535.

Usage Guidelines

Use this command to configure the endpoint IP address and port number.

group nrf mgmt service type nrf endpoint-profile version uri-version

Configures version information.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration

Syntax

uri-version uri_version [ full-version full_version ]

uri_version

Specify the URI version.

Must be a string in the pattern v\d.

full-version full_version

Specify the full version in the format major-version .minor-version .patch-version .[alpha-draft-number ]

Must be a string.

Usage Guidelines

Use this command to configure the version information.