Configures the AAA-based user management parameters.

old-password old_password

Specify the current password.

Must be a string.

new-password new_password

Specify the new password.

Must be a string.

confirm-password new_password

Specify the new password once again to change the password.

Must be a string.

Configures global AMF parameters.

amf-name amf_name

Specify name of the AMF.

Must be a string.

Configures call control policy.

asynch-type-comm { false | true }

Specify whether to enable or disable asynchronous communication.

Must be one of the following:

• false

• true

Default Value: false.

call-control-policy cc_policy_name

Specify the name of the Call Control Policy.

Must be a string.

check-eir { false | true }

Specify whether to enable or disable the parameters to check EIR.

Must be one of the following:

• false

• true

Default Value: false.

default-dnn default_dnn

Specify the default DNN.

Must be a string.

disable-init-csr-reg { false | true }

Specify whether to enable or disable initial CSR registration.

Must be one of the following:

• false

• true

Default Value: true.

disable-rfsp-pcf { false | true }

Specify whether to enable or disable RFSP PCF.

Must be one of the following:

• false

• true

Default Value: false.

enable-auth-periodic-reg { false | true }

Specify whether to enable or disable periodic authentication registration.

Must be one of the following:

• false

• true

Default Value: false.

enable-auth-svc-req { false | true }

Specify whether to enable or disable authentication service request.

Must be one of the following:

• false

• true

Default Value: false.

enable-guti-realloc-periodic-reg { false | true }

Specify whether to enable or disable GUTI reallocation periodic registration.

Must be one of the following:

• false

• true

Default Value: true.

enable-guti-realloc-service-req { false | true }

Specify whether to enable or disable GUTI reallocation service request.

Must be one of the following:

• false

• true

Default Value: false.

report-uli { false | true }

Specify whether to enable or disable ULI report.

Must be one of the following:

• false

• true

Default Value: false.

retrieve-imei { false | true }

Specify whether to enable or disable the parameters to retrieve IMEI.

Must be one of the following:

• false

• true

Default Value: false.

tai-group tai_group_name

Specify name of the TAI group.

Configures global AM policy parameters.

skip { false | true }

Specify whether to skip fetching the AM Policy.

Must be one of the following:

• false

• true

Default Value: false.

Configures enabling policy to apply CoreNetworkType restriction at AMF.

core-network-type-restriction restriction

Specify the core network type restriction.

Must be one of the following:

• 5gc

• override-udm-restrictions

Configures default slice for the subscriber.

name slice_name

Specify name of the slice.

Must be a string.

sdt slice_differentiator_type

Specify the Slice Differentiator Type (SDT).

Must be a string in the octet-string24 pattern. For information on the octet-string24 pattern, see the Input Pattern Types section.

sst slice_service_type

Specify the Slice Service Type (SST).

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

Configures ims-vops-service-3gpp support.

not-supported { false | true }

Specify whether to enable or disable 5G VoPS 3GPP support.

Must be one of the following:

• false

• true

Default Value: true.

reject-voice-centric-ue { false | true }

Specify if VoPS is not supported whether to reject voice-centric UE registration.

Must be one of the following:

• false

• true

Default Value: false.

Configures ims-vops-service-3gpp support.

supported { false | true }

Specify whether to enable or disable 5G VoPS 3GPP support.

Must be one of the following:

• false

• true

Default Value: false.

ue-capability-match-required { false | true }

Specify whether if VoPS is supported UE capability check is required or not required.

Must be one of the following:

• false

• true

Default Value: false.

Configures the UE authentication failure condition type parameter.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• illegal-ms

• no-suitable-cells-in-tracking-area

• plmn-not-allowed

• restricted-service-area

• roaming-not-allowed-in-this-tracking-area

• tracking-area-not-allowed

Default Value: illegal-ms.

Configures the UE subscriber clear condition type.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• 5GS-services-not-allowed

• no-suitable-cells-in-tracking-area

• plmn-not-allowed

• restricted-service-area

• roaming-not-allowed-in-this-tracking-area

• tracking-area-not-allowed

Default Value: plmn-not-allowed.

Configures the AMF context transfer failure condition type parameter.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• no-suitable-cells-in-tracking-area

• plmn-not-allowed

• restricted-service-area

• roaming-not-allowed-in-this-tracking-area

• tracking-area-not-allowed

• ue-identity-not-derived

Default Value: ue-identity-not-derived.

Configures the MME context transfer failure condition type parameter.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• no-suitable-cells-in-tracking-area

• plmn-not-allowed

• restricted-service-area

• roaming-not-allowed-in-this-tracking-area

• tracking-area-not-allowed

• ue-identity-not-derived

Default Value: ue-identity-not-derived.

Configures the DNN mismatch condition type parameter.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• no-suitable-cells-in-tracking-area

• plmn-not-allowed

• restricted-service-area

• roaming-not-allowed-in-this-tracking-area

• tracking-area-not-allowed

Default Value: plmn-not-allowed.

Configures the DNN not subscribed condition type parameter.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• dnn-not-subscribed

Default Value: dnn-not-subscribed.

Configures the GW Unreachable Condition Type parameter.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• no-suitable-cells-in-tracking-area

• plmn-not-allowed

• restricted-service-area

• roaming-not-allowed-in-this-tracking-area

• tracking-area-not-allowed

Default Value: no-suitable-cells-in-tracking-area.

Configures the inter-PLMN roaming condition type parameter.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• 5GS-services-not-allowed

• no-suitable-cells-in-tracking-area

• plmn-not-allowed

• restricted-service-area

• roaming-not-allowed-in-this-tracking-area

• tracking-area-not-allowed

Default Value: plmn-not-allowed.

Configures the peer node no response condition type parameter.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• no-suitable-cells-in-tracking-area

• plmn-not-allowed

• restricted-service-area

• roaming-not-allowed-in-this-tracking-area

• tracking-area-not-allowed

• ue-identity-not-derived

Default Value: ue-identity-not-derived.

Configures the restricted zone code condition type parameter.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• 5GS-services-not-allowed

• no-suitable-cells-in-tracking-area

• plmn-not-allowed

• restricted-service-area

• roaming-not-allowed-in-this-tracking-area

• tracking-area-not-allowed

Default Value: no-suitable-cells-in-tracking-area.

Configures the SMF selection failure condition type parameter.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• no-suitable-cells-in-tracking-area

• plmn-not-allowed

• restricted-service-area

• roaming-not-allowed-in-this-tracking-area

• tracking-area-not-allowed

Default Value: no-suitable-cells-in-tracking-area.

Configures the UDM not available condition type parameter.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• no-suitable-cells-in-tracking-area

• plmn-not-allowed

• restricted-service-area

• roaming-not-allowed-in-this-tracking-area

• tracking-area-not-allowed

Default Value: no-suitable-cells-in-tracking-area.

Configures mapping ARP from SMF to Ngap paging priority.

arp arp_value

Specify the Allocation and Retention Priority (ARP) value from SMF.

Must be an integer in the range of 1-15.

ngap-paging-priority ngap_paging_priority

Specify the paging priority in the paging message.

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

Configures AMF redirection parameters.

enabled { false | true }

Specify whether to enable or disable AMF redirection.

Must be one of the following:

• false

• true

Default Value: false.

Configures UE Context release procedure parameters.

force-smf-update { false | true }

Specify whether to initiate SMF update without PDU list available in release messages.

Must be one of the following:

• false

• true

Default Value: false.

Configures tailist for paging.

use-new-tailist

Specify to use new tailist for paging as last stage.

Configures enabling paging for UE config.

initiate-paging

Specify to enable paging for UE config.

Configures NSSF interaction parameters.

enabled { false | true }

Specify whether to enable or disable NSSF interaction.

Must be one of the following:

• false

• true

Default Value: false.

Configures slicing policy configuration parameters.

inclusion-mode inclusion_mode

Specify the NSSAI Inclusion Mode to be send in Registration Accept.

Must be one of the following:

• A

• B

• C

• D

• None

Default Value: None.

Configures UE Config update procedure parameters.

on-nssf-slice-change { false | true }

Specify whether to initiate UE config update procedure if slice parameter from NSSF changes.

Must be one of the following:

• false

• true

Default Value: false.

on-tai-change { false | true }

Specify whether to initiate UE config update procedure on TAI list changes.

Must be one of the following:

• false

• true

Default Value: false.

Configures UE context transfer related parameters.

allow-interplmn-supi-transfer { false | true }

Specify whether source AMF sends UE context with SUPI.

Must be one of the following:

• false

• true

Default Value: false.

horizontal-key-derivation { false | true }

Specify whether source AMF will generate new key every time.

Must be one of the following:

• false

• true

Default Value: false.

use-source-key { false | true }

Specify whether target AMF will use key received from source AMF.

Must be one of the following:

• false

• true

Default Value: true.

use-source-pcf { false | true }

Specify whether target AMF sends pcfReselectedInd as true in transfer-update and source AMF clears PCF association.

Must be one of the following:

• false

• true

Default Value: true.

Configures enabling policy to apply RatType restriction at AMF.

rat-type-restriction restriction

Specify the RAT type restriction.

Must be one of the following:

• EUTRAN

• NR

• VIRTUAL

• WLAN

• override-udm-restrictions

Configures enabling policy to restrict subscriber for all locations at AMF.

access-type access_type

Specify the access type.

Must be one of the following:

• all

Configures multiple algorithms in priority order.

ciphering-algo ciphering_algorithm

Specify the ciphering algorithm.

Must be one of the following:

• 128-5G-EA1

• 128-5G-EA2

• 5G-EA0

integity-prot-algo integity_protocol_algorithm

Specify the integity protocol algorithm.

Must be one of the following:

• 128-5G-IA1

• 128-5G-IA2

• 5G-IA0

security-algo priority

Specify the priority.

Must be an integer.

Configures the context-transfer-guard timer parameter.

value timeout_duration

Specify the timeout period in seconds. Configure guard timer values, which must be in the range of 0-10.

The default value is 5. The value 0 is used to disable the timer in the procedure.

Configures the ho-supervisory timer parameter.

value timer_value

Specify the timer value in milliseconds.

Must be an integer in the range of 100-10000.

Default Value: 500.

Configures the t3502 timer parameter.

value timeout_duration

Specify the timeout period in seconds.

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

Configures the t3512 timer parameter.

value timeout_duration

Specify the timeout period in seconds.

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

Configures the t3513 timer parameter.

retry max_retries

Specify the maximum number of retries.

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

Default Value: 4.

value timeout_duration

Specify the timeout period in seconds.

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

Default Value: 6.

Configures the t3522 timer parameter.

retry max_retries

Specify the maximum number of retries.

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

Default Value: 4.

value timeout_duration

Specify the timeout period in seconds.

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

Default Value: 6.

Configures the t3550 timer parameter.

retry max_retries

Specify the maximum number of retries.

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

Default Value: 4.

value timeout_duration

Specify the timeout period in seconds.

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

Default Value: 6.

Configures the t3555 timer parameter.

retry max_retries

Specify the maximum number of retries.

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

Default Value: 4.

value timeout_duration

Specify the timeout period in seconds.

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

Default Value: 6.

Configures the t3560 timer parameter.

retry max_retries

Specify the maximum number of retries.

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

Default Value: 4.

value timeout_duration

Specify the timeout period in seconds.

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

Default Value: 6.

Configures the t3570 timer parameter.

retry max_retries

Specify the maximum number of retries.

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

Default Value: 4.

value timeout_duration

Specify the timeout period in seconds.

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

Default Value: 6.

Configures the tguard timer parameter.

value timeout_duration

Specify the timeout period in seconds.

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

Configures the UE connected mode inactivity timer parameter.

value timeout_duration

Specify the timer value in seconds.

Must be an integer in the range of 30-25200.

Configures the tidt timer parameter.

value timeout_duration

Specify the timeout period in seconds.

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

Configures the tn2 timer parameter.

value timeout_duration

Specify the timeout period in seconds.

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

Configures the purge timer parameter.

value timeout_duration

Specify the timeout period in seconds.

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

Configures the DNN policy parameter.

dnn-policy dnn_name

Specify name of the DNN.

Must be a string.

ims-enabled { false | true }

Specify whether IMS is enabled for DNN.

Must be one of the following:

• false

• true

Default Value: false.

lbo-roaming-allowed { false | true }

Specify whether Local Breakout Roaming is supported.

Must be one of the following:

• false

• true

Default Value: false.

nf-profile-name nf_profile_name

Specify name of the NF profile.

Must be a string.

Configures the network element profile list.

smf smf_profile_name

Specify name of the SMF network element profile.

Must be a string.

Configures NF profile parameters.

nf_profile_name

Specify name of the NF profile.

Must be a string.

Configures the NF profile type parameter.

type nf_profile_type

Specify the NF profile type.

Must be one of the following:

• ausf

• nrf

• nssf

• pcf

• smf

• udm

Configures GRPC endpoint parameters.

host host_name

Specify the host name.

Must be a string.

port port_number

Specify the port number.

Must be an integer.

Configures HTTP endpoint parameters.

base-url base_url

Specify the base URL.

Must be a string.

Configures the operator policy.

ccp-name ccp_name

Specify name of the CCP.

Must be a string.

emergency-profile-name emergency_profile_name

Specify name of the emergency profile.

nf-profile-name nf_profile_name

Specify name of the NF profile.

Must be a string.

operator-policy policy_name

Specify name of the operator policy.

Must be a string.

paging-map-name paging_map_name

Specify name of the 5G paging map.

Must be a string of 1-64 characters.

Configures network element profiles.

amf amf_ne_profile_name

Specify name of the AMF network element profile.

Must be a string.

ausf ausf_ne_profile_name

Specify name of the AUSF network element profile.

Must be a string.

nssf nssf_ne_profile_name

Specify name of the NSSF network element profile.

Must be a string.

pcf pcf_ne_profile_name

Specify name of the PCF network element profile.

Must be a string.

smf smf_ne_profile_name

Specify name of the SMF network element profile.

Must be a string.

udm udm_ne_profile_name

Specify name of the UDM network element profile.

Must be a string.

Configures the paging algorithm.

action action

Specify the action.

Must be one of the following:

• all_gnb_all_tai

• all_gnb_last_tai

• all_gnb_remaining_tai_all

• all_gnb_remaining_tai_seq

• last_gnb_last_tai

• last_n_gnb_last_tai

max-n-gnb max_gnbs_to_page

Specify the max number of gNBs to page.

Must be an integer in the range of 1-5.

max-paging-attempts max_paging_attempts

Specify the maximum number of paging attempts.

Must be an integer in the range of 1-5.

paging-algo paging_algorithm_name

Specify name of the paging algorigthm.

Must be a string of 1-64 characters.

t3513-timeout paging_timeout

Specify the paging timeout value in seconds.

Must be an integer in the range of 1-10.

Configures the paging map parameters.

paging_map_name

Specify name of the 5G paging map.

Must be a string of 1-64 characters.

Configures the paging map precedence parameter.

arp-value arp_value

Specify the Allocation and Retention Priority (ARP) value.

Must be an integer in the range of 1-15.

dereg-value deregistration_trigger_value

Specify the deregistration trigger value.

Must be one of the following:

• amf_init

• udm_init

dnn-value dnn_value

Specify the Data Network Name (DNN) value.

Must be a string of 1-64 characters.

fiveqi-value 5qi_value

Specify the 5G QoS Indicator value.

Must be an integer in the range of 1-85.

paging-profile-name paging_profile_name

Specify name of the 5G paging profile.

Must be a string of 1-64 characters.

ppi-value ppi_value

Specify the Paging Policy Indicator (PPI) value.

Must be an integer in the range of 1-7.

precedence map_precedence_level

Specify the map precedence level.

Must be an integer in the range of 1-255.

trigger-type trigger_type

Specify the paging trigger type.

Must be one of the following:

• 5qi

• arp

• dereg

• dnn

• ppi

• uecfg

Configures paging profile parameters.

paging_profile_name

Specify name of the 5G paging profile.

Must be a string of 1-64 characters.

Configures paging stage information.

paging-algo paging_algorigthm_name

Specify name of the paging algorigthm.

Must be a string of 1-64 characters.

paging_stage_precedence

Specify the stage.

Must be an integer in the range of 1-5.

Configures the operator policy.

operator-policy-name operator_policy_name

Specify name of the operator policy.

Must be a string.

plmn-policy plmn_name

Specify name of the PLMN.

Must be a string of 5-6 characters in the plmn-string pattern. For information on the plmn-string pattern, see the Input Pattern Types section.

Configures SUPI policy information.

operator-policy-name operator_policy_name

Specify name of the operator policy.

Must be a string.

supi-policy supi_prefix

Specify the SUPI prefix.

Must be a string of 1-15 characters in the supi-string pattern. For information on the supi-string pattern, see the Input Pattern Types section.

Configures timeout value for registration.

value timer_value

Specify the timer value in seconds.

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

Configures AMF service configuration parameters.

amf-name amf_name

Specify name of the AMF.

Must be a string.

amf-services amf_service_name

Specify name of the AMF service.

Must be a string.

emergency-profile-name emergency_profile_name

Specify name of the emergency profile.

locality locality_name

Specify the locality for Geo support.

Must be a string.

operator-policy-name operator_policy_name

Specify name of the operator policy.

relative-amf-capacity relative_amf_capacity

Specify the relative AMF capacity.

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

Default Value: 127.

validate-Tais { false | true }

Specify whether to enable or disable TAI validation.

Must be one of the following:

• false

• true

Default Value: false.

Configures the Globally Unique AMF ID (GUAMIS).

mcc mobile_country_code

Specify the mobile country code.

Must be a string.

mnc mobile_network_code

Specify the mobile network code.

Must be a string.

pointer amf_pointer

Specify the pointer value.

Must be an integer.

region-id amf_region_id

Specify the AMF region ID.

Must be an integer.

set-id amf_set_id

Specify the AMF set ID.

Must be an integer.

Configures the UE authentication failure condition type parameter.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• illegal-ms

• no-suitable-cells-in-tracking-area

• plmn-not-allowed

• restricted-service-area

• roaming-not-allowed-in-this-tracking-area

• tracking-area-not-allowed

Default Value: illegal-ms.

Configures the UE subscriber clear condition type.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• 5GS-services-not-allowed

• no-suitable-cells-in-tracking-area

• plmn-not-allowed

• restricted-service-area

• roaming-not-allowed-in-this-tracking-area

• tracking-area-not-allowed

Default Value: plmn-not-allowed.

Configures the AMF context transfer failure condition type parameter.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• no-suitable-cells-in-tracking-area

• plmn-not-allowed

• restricted-service-area

• roaming-not-allowed-in-this-tracking-area

• tracking-area-not-allowed

• ue-identity-not-derived

Default Value: ue-identity-not-derived.

Configures the MME context transfer failure condition type parameter.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• no-suitable-cells-in-tracking-area

• plmn-not-allowed

• restricted-service-area

• roaming-not-allowed-in-this-tracking-area

• tracking-area-not-allowed

• ue-identity-not-derived

Default Value: ue-identity-not-derived.

Configures the DNN mismatch condition type parameter.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• no-suitable-cells-in-tracking-area

• plmn-not-allowed

• restricted-service-area

• roaming-not-allowed-in-this-tracking-area

• tracking-area-not-allowed

Default Value: plmn-not-allowed.

Configures the DNN not subscribed condition type parameter.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• dnn-not-subscribed

Default Value: dnn-not-subscribed.

Configures the gw unreachable condition type parameter.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• no-suitable-cells-in-tracking-area

• plmn-not-allowed

• restricted-service-area

• roaming-not-allowed-in-this-tracking-area

• tracking-area-not-allowed

Default Value: no-suitable-cells-in-tracking-area.

Configures the inter-PLMN roaming condition type parameter.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• 5GS-services-not-allowed

• no-suitable-cells-in-tracking-area

• plmn-not-allowed

• restricted-service-area

• roaming-not-allowed-in-this-tracking-area

• tracking-area-not-allowed

Default Value: plmn-not-allowed.

Configures the peer node no response condition type parameter.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• no-suitable-cells-in-tracking-area

• plmn-not-allowed

• restricted-service-area

• roaming-not-allowed-in-this-tracking-area

• tracking-area-not-allowed

• ue-identity-not-derived

Default Value: ue-identity-not-derived.

Configures the restricted zone code condition type parameter.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• 5GS-services-not-allowed

• no-suitable-cells-in-tracking-area

• plmn-not-allowed

• restricted-service-area

• roaming-not-allowed-in-this-tracking-area

• tracking-area-not-allowed

Default Value: no-suitable-cells-in-tracking-area.

Configures the SMF selection failure condition type parameter.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• no-suitable-cells-in-tracking-area

• plmn-not-allowed

• restricted-service-area

• roaming-not-allowed-in-this-tracking-area

• tracking-area-not-allowed

Default Value: no-suitable-cells-in-tracking-area.

Configures the UDM not available condition type parameter.

cause-code-5gmm cause_code_5gmm

Specify the condition type.

Must be one of the following:

• no-suitable-cells-in-tracking-area

• plmn-not-allowed

• restricted-service-area

• roaming-not-allowed-in-this-tracking-area

• tracking-area-not-allowed

Default Value: no-suitable-cells-in-tracking-area.

Configures the AMF ID (oauth2-enabled ) to enable the client authorization support to NRF.

oauth2-enabled

Enable the OAuth2 client authorization to register the AMF with NRF. The default value is false.

access-token-jws-algo { HS256 | ES256 | RS256 }

Specify the type of the access token for the JWS Algorithm authorization.

access-token-jws-key { shared_secret_key | public_key }

Specify the type of the access token for the JWS Key authorization.

Configures Globally Unique MME Identifier (GUMMEI) parameters.

address peer_mme_ip_address

Specify the IP address if the peer MME.

Must be a string in the ipv4-address pattern. For information on the ipv4-address pattern, see the Input Pattern Types section.

-Or-

Must be a string in the ipv6-address pattern. For information on the ipv6-address pattern, see the Input Pattern Types section.

group-id mme_group_id

Specify the MME group ID.

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

mcc mobile_country_code

Specify the three-digit mobile country code. For example, 123.

Must be a string in the three-digit pattern. For information on the three-digit pattern, see the Input Pattern Types section.

mme-code mme_code

Specify the MME code.

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

mnc mobile_network_code

Specify the two- or three-digit mobile network code. For example, 23, 456.

Must be a string in the two-or-three-digit pattern. For information on the two-or-three-digit pattern, see the Input Pattern Types section.

Configures TAI match.

mcc mobile_country_code

Specify the three-digit mobile country code. For example, 123.

Must be a string in the three-digit pattern. For information on the three-digit pattern, see the Input Pattern Types section.

mnc mobile_network_code

Specify the two- or three-digit mobile network code. For example, 23, 456.

Must be a string in the two-or-three-digit pattern. For information on the two-or-three-digit pattern, see the Input Pattern Types section.

priority tai_match_priority

Specify the TAI match priority value.

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

Configures Tracking Area Code parameters.

Configures the Tracking Area Code wildcard for peer MME.

address ip_address

Specify the IP address of the peer MME.

Must be a string in the ipv4-address pattern. For information on the ipv4-address pattern, see the Input Pattern Types section.

-Or-

Must be a string in the ipv6-address pattern. For information on the ipv6-address pattern, see the Input Pattern Types section.

Configures the Tracking Area Code start value.

address ip_address

Specify the IP address of the peer MME.

Must be a string in the ipv4-address pattern. For information on the ipv4-address pattern, see the Input Pattern Types section.

-Or-

Must be a string in the ipv6-address pattern. For information on the ipv6-address pattern, see the Input Pattern Types section.

start tac_start_value

Specify the Tracking Area Code start value.

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

Configures the Tracking Area Code range for peer MME.

address ip_address

Specify the IP address of the peer MME.

Must be a string in the ipv4-address pattern. For information on the ipv4-address pattern, see the Input Pattern Types section.

-Or-

Must be a string in the ipv6-address pattern. For information on the ipv6-address pattern, see the Input Pattern Types section.

end tac_end_value

Specify the Tracking Area Code range for Peer MME.

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

Configures peer SMF+PGW-C parameters.

fqdn fqdn

Specify the PGW fully qualified domain name.

Must be a string.

smf-network-element-profile smf_profile_name

Specify name of the SMF network element profile.

Must be a string.

Configures the AMF Services ID (relative-amf-capacity ) to enable the Relative Capacity Configuration Update feature in AMF.

relative-amf-capacity capacity_number

relative-amf-capacity capacity_number —Specifies the AMF capacity, within the range of 0–255. The default value is 127.

Configures TAI groups.

tai_group_name

Specify name of the TAI group.

Enable or disable the AMF tools.

enable { false | true }

Specify to enable or disable the AMF tools.

Must be one of the following:

• false

• true

Default Value: false.

Configures AMF mock tool.

external-ip external_ip_address

Specify the external IP address.

Must be a string.

Configures lattice.

lattic-tar-url lattic_tar_url

Specify the lattice tar URL.

Must be a string.

sctp-ip-address sctp_ip_address

Specify the external IP address for SCTP.

Must be a string in the ipv4-address pattern. For information on the ipv4-address pattern, see the Input Pattern Types section.

-Or-

Must be a string in the ipv6-address pattern. For information on the ipv6-address pattern, see the Input Pattern Types section.

sctp-k8-node-name sctp_k8_node_name

Specify the kubernetes node name on which lattice is to be deployed.

Must be a string.

test-companion-tar-url test_companion_tar_url

Specify the test companion tar URL.

Must be a string.

Configures APN groups.

name apn_group_name

Specify name of the APN group.

Must be a string.

Configures APN group parameters.

apns apn_name

Specify name of the APN.

Must be a string.

Configures APN profile parameters.

apn_profile_name

Specify name of the APN profile.

Must be a string.

Changes the current working directory.

directory

Specify the directory name.

Must be a string.

Clears the data from the Cisco Data Layer (CDL) datastore.

db-name database

Specify the database name to be queried for displaying the session details.

Must be a string of 1 to 16 characters.

filter filter

Specify the filter.

map-id map_id

Specify the map ID to display the data for a map.

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

slice-name slice_name

Specify the slice name to be queried.

Must be a string of 1 to 16 characters.

Displays the Kafka parameters for Geo Replication.

describe

Describe the kafka topics or consumer groups.

consumer-groups name

Displays the kafka consumer groups. By default, all the consumer groups are described

topics name kafka_topic_name

Displays the specified kafka topics. By default, all the internal topics are described

include-internal-topics

Indicates to include the internal topics.

list

Lists the kafka topics or the consumer groups.

consumer-groups

Lists the kafka topics or the consumer groups.

topics include-internal-topics

List all the kafka topics that include the internal topics.

Displays the session data from the datastore.

count

Display the session count information.

detailed

Display the session details with data.

db-name db_name

Specify the database name to be queried for displaying the session details.

Must be a string of 1 to 16 characters.

key key_value

Specify the query value.

Must be a string of 0 to 512 characters.

map-id map_id

Specify the map ID to display the data for a map.

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

limit limit

Specify the maximum number of records to display.

Must be an integer in the range of 1-500.

filter condition { ends-with | match | starts-with }

Specify the query expression to filter the results of query.

purge-on-eval

Displays the list of sessions that have purge-on-eval flag set to true or false.

next-eval-end-time

Displays the sessions that have the next-eval-time less than this time.

next-eval-start-time

Displays the sessions that have the next-eval-time greater than this time.

Displays the status of the database from the datastore.

db-name database_name

Specify the database name to display the status.

Must be a string of 1 to 16 characters.

Clears the IP Address Management (IPAM) operational data.

Clears the IP Address Management (IPAM) operational data.

Clears subscriber data.

all

Specify to remove all subscriber data.

gr-instance gr_instance

Specify the subscribers from the GR instance.

imei imei_id

Specify the International Mobile Equipment Identity.

Must be a string of 15-16 characters.

namespace namespace

NOTE: This keyword is deprecated, use nf-service instead. Specifies the product namespace under which to search.

Default Value: cisco-mobile-infra:none.

nf-service nf_service

Specify the network function service under which to search.

Default Value: cisco-mobile-infra:none.

supi supi_id

Specify to remove subscriber data associated with the SUPI ID.

Must be a string of 1-63 characters.

Clears the subscriber data.

all

Clears all the subscriber data.

gnodeb-id { mcc mcc_value | mnc mnc_value

Specify the gNodeB ID.

gr-instance gr_instance

Specify the subscribers from the GR instance.

imei imei_id

Specify the International Mobile Equipment Identity.

Must be a string of 15 to 16 characters.

namespace namespace

Specify the product namespace under which to search.

Note	This keyword is deprecated, use nf-service instead.

Default Value: cisco-mobile-infra:none

nf-service nf_service

Specify the network function service under which to search.

Default Value: cisco-mobile-infra:none.

supi supi_id

Specify to remove subscriber data associated with the SUPI ID.

Must be a string of 1 to 63 characters.

Displays and clears subscriber data based on specified criteria.

gnodeb-id gnodeb_id

Specify the gnodeb-id.

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

mcc mobile_country_code

Specify the mobile country code.

Must be a string in the two-or-three-digit pattern. For information on the two-or-three-digit pattern, see the Input Pattern Types section.

mnc mobile_network_code

Specify the mobile network code.

Must be a string in the two-or-three-digit pattern. For information on the two-or-three-digit pattern, see the Input Pattern Types section.

Configures HTTP header parameters.

user-agent user_agent_header

Specify the user agent header.

Must be one of the following:

• app-name

• cluster-name

• disable

Default Value: app-name.

Configures HTTP ping parameters.

interval ping_interval

Specify, in milliseconds, the time interval between two HTTP pings.

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

Default Value: 10000.

timeout ping_timeout

Specify, in milliseconds, the ping timeout duration to detect if remote host is down.

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

Default Value: 5000.

Configures inbound client interface parameters.

interface interface_name

Specify name of the interface.

Configures Overload configuration parameters.

reject-code response_code

Specify the response code to be used when pending limit exceeds.

Must be an integer.

Configures pending limit parameter.

request max_pending_request_limit

Specify the maximum pending request limit to allow.

Must be an integer.

Default Value: 10240.

Configures Overload configuration parameters.

reject-code response_code

Specify the response code to be used when pending limit exceeds.

Must be an integer.

Configures pending limit parameter.

request max_pending_request_limit

Specify the maximum pending request limit to allow.

Must be an integer.

Default Value: 10240.

Configures outbound host ping parameter.

backoff backoff_interval

Specify, in milliseconds, the backoff time interval to wait when remote host is detected down before pinging again.

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

Default Value: 0.

interval ping_interval

Specify, in milliseconds, the time interval between two pings.

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

Default Value: 0.

timeout ping_timeout

Specify the ping timeout duration, in milliseconds, to detect remote host down.

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

Default Value: 0.

Configures outbound client interface parameters.

interface interface_name

Specify the interface.

Configures outbound host ping parameter.

backoff backoff_interval

Specify, in milliseconds, the backoff time interval to wait when remote host is detected down before pinging again.

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

Default Value: 0.

interval ping_interval

Specify, in milliseconds, the time interval between two pings.

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

Default Value: 0.

timeout ping_timeout

Specify the ping timeout duration, in milliseconds, to detect remote host down.

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

Default Value: 0.

Configures consecutive failure configuration parameters.

codes failure_codes

Specify the list of failure codes to be considered, such as timeout, 503, etc.

Must be a string.

You can configure a maximum of 10 elements with this keyword.

count consecutive_failure_count

Specify the consecutive failure limit count to detect remote host as down.

Must be an integer.

Default Value: 0.

Configures pending limit configuration.

response response_message_limit

Specify the pending response message limit to detect remote host as down.

Must be an integer.

Default Value: 1024.

Configures consecutive failure configuration parameters.

codes failure_codes

Specify the list of failure codes to be considered, such as timeout, 503, etc.

Must be a string.

You can configure a maximum of 10 elements with this keyword.

count consecutive_failure_count

Specify the consecutive failure limit count to detect remote host as down.

Must be an integer.

Default Value: 0.

Configures pending limit configuration.

response response_message_limit

Specify the pending response message limit to detect remote host as down.

Must be an integer.

Default Value: 1024.

Configures the commit parameters.

abort persist-id persist_id

Specify to abort commit. Specify the persistence ID for the commit operation.

Must be an integer.

confirm persist-id persist_id

Specify to confirm commit. Specify the persistence ID for the commit operation.

Must be an integer.

persist-id persist_id

Specify the persistence ID for the commit operation.

Must be an integer.

Compares the running configuration to another configuration or a file.

filename [.kube | .ssh] |

Specify the file name ending with .kube/.ssh or the directory path of the file to be compared.

Must be a string.

another_configuration

Specify the configuration to be compared against.

Must be a string.

Manipulates the software configuration information.

exclusive

Specify to enter the exclusive configuration mode.

no-confirm

Specify to apply the command without asking for confirmation.

shared

Specify to enter the shared configuration mode.

terminal

Specify to enter the terminal configuration mode.

Displays configuration error information.

Configures code coverage utilities.

container-stop container_stop

Specify the container stop.

Must be a string.

Default Value: false.

Configures DBS parameters.

dbs dbs_name

Specify name of the DBS.

Must be a string.

Configures endpoint parameters.

endpoints endpoint_name

Specify the endpoint host name.

Must be a string.

port port_number

Specify the port number.

Must be an integer.

Configures notification endpoint parameters.

host host_name

Specify the host name.

Must be a string.

port port_number

Specify the port number.

Must be an integer.

Configures Session DB parameters.

slice-name slice_name

Specify name of the slice.

Must be a string.

Configures endpoint parameters.

endpoints endpoint_name

Specify the endpoint host name.

Must be a string.

port port_number

Specify the port number.

Must be an integer.

Configures debug settings for AMF NGAP endpoint.

go-debug

Specifiy to debug.

Must be a string.

Configures debug settings for AMF REST endpoint.

go-debug

Specifiy to debug.

Must be a string.

Configures debug settings for amf-sctp-lb.

go-debug

Specifiy to debug.

Must be a string.

Configures debug settings for AMF service.

go-debug

Specifiy to debug.

Must be a string.

Configures the product deployment parameters.

app-name application_name

Specify name of the application.

Must be a string.

cluster-name cluster_name

Specify name of the cluster.

Must be a string.

dc-name datacenter_name

Specify name of the datacenter.

Must be a string.

logical-nf-instance-id logical_nf_instance_id

Specify the logical NF instance ID.

Must be an integer.

Default Value: 0.

model deployment_model

Specify the deployment model. Default: Large.

Must be one of the following:

• small

Configures the deployment CPU resource parameter.

cpu cpu_size

Specify the CPU size in millicores.

Must be an integer in the range of 2000-1000000.

Default Value: 18000.

Displays the command information.

command

Specify the command name to display the detailed information about the command.

Must be a string.

The command must be one of the following:

• aaa

• cd

• cdl

• clear

• commit

• compare

• config

• describe

• dump

• exit

• geo

• help

• history

• id

• idle-timeout

• ignore-leading-space

• job

• leaf-prompting

• license

• logout

• monitor

• no

• paginate

• quit

• reconcile

• screen-length

• screen-width

• search

• send

• show

• show-defaults

• smiuser

• system

• terminal

• timestamp

• transaction

• who

Displays diagnostics information.

Displays diagnostics information.

Removes the transaction history.

transactionhistory

Dump the transaction history.

Configures EDR reporting parameters.

reporting reporting_status

Specify to enable or disable EDR reporting.

Must be one of the following:

• disable

• enable

Default Value: disable.

Configures subscriber EDR reporting.

subscribers subscribers_for_edr_reporting

Specify the subscribers to enable EDR reporting. For example, imsi-123456789012345.

Must be a string.

You can configure a maximum of 10 elements with this keyword.

Configures EDR file parameters.

file { transaction | transaction-collision }

Specify name of the EDR file.

reporting reporting_status

Specify to enable or disable reporting of this file.

Must be one of the following:

• disable

• enable

Default Value: disable.

verbose verbosity_status

Specify to enable or disable field description or long names in the file.

Must be one of the following:

• disable

• enable

Default Value: disable.

Disables procedure IDs.

procedure-id procedure_ids

Specify the procedure ID value(s)/name(s).

Must be a string.

Configures EDR file flush parameters.

interval file_flush_interval

Specify, in milliseconds, the file flush interval.

Must be an integer.

Default Value: 1000.

Configures EDR file limit parameters.

count max_files_to_preserve

Specify the maximum number of files to be preserved.

Must be an integer.

Default Value: 10.

size max_single_file_size

Specify the maximum single file size limit in MB.

Must be an integer.

Default Value: 100.

Disables transaction-level procedure ID configuration.

procedure procedure_id

Specify the procedure ID value/name.

Must be a string.

Disables event IDs.

event-id event_ids

Specify the event ID value(s)/name(s).

Must be a string.

Disables procedure-level event ID configuration.

event event_id

Specify the event ID value/name.

Must be a string.

Disables field IDs.

field-id field_ids

Specify the field ID value(s)/name(s).

Must be a string.

Displays endpoint status.

Displays endpoint information.

Exits the current configuration mode and returns to the parent configuration mode.

Configures Geo Admin Controller to enable or disable maintenance mode.

mode { false | true }

Specify whether to enable or disable maintenance mode. To enable, set to true.

Must be one of the following:

• false

• true

Default Value: false.

Configures Geo Admin Controller for reset role.

instance-id instance_id

Specify the instance ID for geo command.

role new_role

Specify the new role for the specified site.

Configures Geo Admin Controller for trigger failover.

failback-interval failback_interval

Specify, in seconds, the interval between notify failover and actual failover.

Must be a string.

instance-id instance_id

Specify the instance ID for geo command.

role new_role

Specify the new role for the specified site.

Configures configuration of pods to be monitored.

failedReplicaPercent failed_replica_precentage

Specify the percentage of failed replica after which GR failover will get triggered.

Must be an integer in the range of 10-100.

pods pod_name

Specify the name of the pod to be monitored.

Must be a string.

retryCount retry_count

Specify the counter value to retry if pod failed to ping after which pod is marked as down.

Must be an integer in the range of 1-10.

retryFailOverInterval retry_interval

Specify, in milliseconds, the retry interval if pod ping fails.

Must be an integer in the range of 200-10000.

retryInterval retry_interval

Specify, in milliseconds, the retry interval if pod ping is successful.

Must be an integer in the range of 200-10000.

Configures remote cluster monitoring parameters.

retryCount retry_count

Specify the retry count if remote cluster is not reachable. To disable, set to 0.

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

Default Value: 3.

retryInterval retry_interval

Specify, in milliseconds, the retry interval after which status of the remote site will be fetched.

Must be an integer in the range of 200-50000.

Default Value: 3000.

Configures traffic monitoring configuration.

thresholdCount threshold_count

Specify the number of calls received for standby instance. To disable, set to 0.

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

Default Value: 0.

thresholdInterval threshold_interval

Specify, in milliseconds, the maximum duration window to hit the threshold count value.

Must be an integer in the range of 100-10000.

Default Value: 3000.

Configures VIP monitoring parameters.

instance instance_id

Specify the instance ID.

Must be an integer in the range of 1-8.

Configures VIP interface monitoring parameters.

retryCount retry_count

Specify the counter value to retry if VIP failed to ping after which VIP is marked as down.

Must be an integer in the range of 1-10.

retryFailOverInterval retry_interval

Specify, in milliseconds, the retry interval if VIP failed to ping.

Must be an integer in the range of 200-10000.

retryInterval retry_interval

Specify, in milliseconds, the retry interval if VIP pinged successfully.

Must be an integer in the range of 200-10000.

vipIp vip_ip

Specify the IPv4 address.

Must be a string.

vipPort vip_port_number

Specify the diagnostic port number.

Must be an integer.

vip_interface_name

Specify name of the interface to monitor.

Must be a string.

Configures NF management group name.

failure-handling-profile fh_profile_name

Specify name of the Failure Handling profile for the NRF Management functionality.

Must be a string.

locality locality_name

Specify the locality information.

Must be a string.

nf-mgmt mgmt_group_name

Specify name of the NRF management group.

Must be a string.

nrf-mgmt-group nrf_mgmt_group_name

Specify name of the NRF management group.

Must be a string.

Configures the heartbeat interval parameter.

interval heartbeat_interval

Specify the heartbeat interval in seconds.

Must be an integer.

Configures NRF discovery group parameters.

discovery group_name

Specify name of the NRF discovery group.

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.

Configures the NRF discovery service name.

nrf nrf_service_name

Specify name of the NRF discovery service.

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.

Configures endpoint profile parameters2.

api-root api_root

Specify the API root.

Must be a string.

api-uri-prefix api_uri_prefix

Specify the API URI prefix.

Must be a string.

endpoint-profile endpoint_profile_name

Specify name of the endpoint profile.

Must be a string.

uri-scheme uri_scheme

Specify the URI scheme.

Must be one of the following:

• http

• https

Configures endpoint parameters.

capacity endpoint_capacity

Specify the endpoint capacity.

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

Default Value: 10.

priority priority

Specify the node priority for endpoint.

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

endpoint_name

Specify name of the endpoint.

Must be a string.

Configures the endpoint IP address and port number parameters. This command is common to multiple NF clients, and is available in the following configuration modes.

ipv4 ipv4_address

Specify the IPv4 address.

Must be a string in the ipv4-address pattern. For information on the ipv4-address pattern, see the Input Pattern Types section.

ipv6 ipv6_address

Specify the IPv6 address.

Must be a string in the ipv6-address pattern. For information on the ipv6-address pattern, see the Input Pattern Types section.

port port_number

Specify the port number.

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

Configures the endpoint IP address and port number parameters. This command is common to multiple NF clients, and is available in the following configuration modes.