cnSGW Command Reference

test dns-query

Tests FQDN resolution.

Command Mode

Exec

Syntax

test dns-query { fqdn fqdn | num-ipv4 ipv4_count | num-ipv4v6 ipv4v6_count | num-ipv6 ipv6_count } 

fqdn fqdn

Specify the Fully Qualified Domain Name (FQDN) of the node for which DNS query has to be sent.

Must be a string of 1-255 characters.

num-ipv4 ipv4_count

Specify the number of IPv4 to be used for DNS query.

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

num-ipv4v6 ipv4v6_count

Specify the number of IPv4v6 to be used for DNS query.

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

num-ipv6 ipv6_count

Specify the number of IPv6 to be used for DNS query.

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

Usage Guidelines

Use this command to test FQDN of the node for which dns query has to be sent.

policy call-control-profile

Configures SGW call control profile for operator policy.

Syntax

call-control-profile sgw_cc_profile_name charging-mode sgw_charging_mode sgw-charging-profile sgw_charging_profile_name 

call-control-profile sgw_cc_profile_name

Specify name of the SGW Call Control Profile for operator policy.

Must be a string.

charging-mode sgw_charging_mode

Specify the SGW charging mode.

Must be one of the following:

  • gtpp

  • none

sgw-charging-profile sgw_charging_profile_name

Specify name of the associated SGW charging profile.

Usage Guidelines

Use this command to configure SGW call control profile for operator policy.

policy call-control-profile cc

Configures charging characteristics selection preference parameter.

Syntax

cc prefer cc_selection_preference 

prefer cc_selection_preference

Specify the preference for selecting charging characteristics.

Must be one of the following:

  • hlr-hss-value : Specify hlr-hss-value - value received from serving node.

  • local-value : Specify local-value - value defined locally.

Default Value: hlr-hss-value.

Usage Guidelines

Use this command to configure charging characteristics selection preference parameter.

policy call-control-profile cc local-value

Configures local value for charging characteristics.

Syntax

local-value profile profile_index 

profile profile_index

Specify the local profile index.

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

Default Value: 8.

Usage Guidelines

Use this command to configure local value for charging characteristics.

policy dnn

Configures the virtual DNN to operator DNN mapping.

Command Mode

Exec > Global Configuration (config)

Syntax

dnn dnn_policy_name [ profile dnn_profile_name ] 

dnn dnn_policy_name

Specify name of the DNN policy.

Must be a string.

profile dnn_profile_name

Specify name of the DNN profile.

Must be a string.

Usage Guidelines

Use this command to configure the virtual DNN to operator DNN mapping.

policy dnn dnn dnn

Configures the virtual DNN to a network DNN.

Syntax

dnn dnn_name [ profile dnn_profile_name ] dnn-list dnn_list 

dnn-list dnn_list

Specify the additional list of DNNs to be associated for the DNN profile.

Must be a string.

dnn dnn_name

Specify name of the DNN.

Must be a string.

profile dnn_profile_name

Specify name of the DNN profile.

Must be a string.

Usage Guidelines

Use this command to configure the virtual DNN to a network DNN.

policy dnn dnn network-identifier

Configures the network identifier.

Command Mode

Exec > Global Configuration (config) > DNN Configuration (config-dnn-policy_name )

Syntax

dnn network-identifier network_identifier [ profile profile_name ] [ dnn-list dnn_list ] 

network-identifier network_identifier

Specify the network identifier.

Must be a string.

profile profile_name

Specify name of the profile.

Must be a string.

Usage Guidelines

Use this command to configure the network identifier.

policy dnn dnn network-identifier operator-identifier

Configures the operator identifier.

Command Mode

Exec > Global Configuration (config) > DNN Configuration (config-dnn-policy_name )

Syntax

dnn network-identifier network_identifier operator-identifier operator_identifier [ profile profile_name ] 

operator-identifier operator_identifier

Specify the operator identifier.

Must be a string.

profile profile_name

Specify name of the profile.

Must be a string.

Usage Guidelines

Use this command to configure the operator identifier.

policy dnn dnn operator-identifier

Configures the operator identifier.

Command Mode

Exec > Global Configuration (config) > DNN Configuration (config-dnn-policy_name )

Syntax

dnn operator-identifier operator_identifier [ profile profile_name ] [ dnn-list dnn_list ] 

operator-identifier operator_identifier

Specify the operator identifier.

Must be a string.

profile profile_name

Specify name of the profile.

Must be a string.

Usage Guidelines

Use this command to configure the operator identifier.

policy network-capability

Configures Network Capability Policy configuration.

Command Mode

Exec > Global Configuration (config)

Syntax

policy network-capability policy_name [ link-mtu link_mtu | max-supported-pkt-filter max_supported_pkt_filter | nw-support-local-address-tft { false | true } ] 

link-mtu link_mtu

Specify name of the Network Capability Policy.

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

Default Value: 1500.

max-supported-pkt-filter max_supported_pkt_filter

Specify the maximum supported packet filters.

Must be an integer in the range of 16-256.

Default Value: 16.

network-capability policy_name

Specify name of the Network Capability Policy.

Must be a string.

nw-support-local-address-tft { false | true }

Enable or disable network support for local address in TFT.

Must be one of the following:

  • false

  • true

Default Value: false.

Usage Guidelines

Use this command to configure Network Capability Policy configuration.

policy operator

Configures the operator policy configuration.

Command Mode

Exec > Global Configuration (config)

Syntax

policy operator policy_name call-control-profile sgw_cc_profile_name roaming-status roaming_status 

call-control-profile sgw_cc_profile_name

Specify name of the associated SGW Call Control profile.

operator policy_name

Specify name of the operator policy.

Must be a string.

roaming-status roaming_status

Specify the roaming status.

Must be one of the following:

  • roamer

  • visitor-hrt

  • visitor-lbo

Usage Guidelines

Use this command to configure the operator policy specific configuration.

policy operator policy

Configures DNN policy parameters.

Command Mode

Exec > Global Configuration (config) > Operator Policy Configuration (config-operator-policy_name )

Syntax

policy dnn dnn_policy_name [ network-capability network_capability ] 

dnn dnn_policy_name

Specify name of the DNN policy.

Must be a string.

network-capability network_capability

Specify the network capability.

Must be a string.

secondary secondary

Specify the secondary.

Must be a string.

Usage Guidelines

Use this command to configure DNN policy parameters.

policy path-failure-detection

Configures path failure detection policy-specific configuration.

Command Mode

Exec > Global Configuration (config)

Syntax

policy path-failure-detection policy_name max-remote-rc-change max_remote_rc_change 

max-remote-rc-change max_remote_rc_change

Specify the maximum remote restart counter change.

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

path-failure-detection policy_name

Specify name of the Path Failure Detection policy.

Must be a string.

Usage Guidelines

Use this command to configure path failure detection policy-specific configuration.

policy path-failure-detection ignore

Configures to ignore counter values, echo timeouts, or echo failures.

Command Mode

Exec > Global Configuration (config) > Path Failure Detection Policy Configuration (config-path-failure-detection-policy_name )

Syntax

ignore type ignore_type 

type ignore_type

Specify to ignore restart counter values, echo timeouts, or echo failures.

Must be one of the following:

  • control-rc-change

  • echo-failure

  • echo-rc-change

Usage Guidelines

Use this command to configure ignoring counter values, echo timeouts, or echo failures.

policy subscriber

Configures SMF policy parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

policy subscriber policy_name 

policy subscriber policy_name

Specify name of the subscriber policy.

Must be a string.

Usage Guidelines

Use this command to configure SMF policy parameters.

policy subscriber list-entry

Configures operator policy selection match criteria definition.

Command Mode

Exec > Global Configuration (config) > Subscriber Policy Configuration (config-subscriber-policy_name )

Syntax

precedence precedence_number [ sst slice_service_type | sdt slice_differentiator_type | supi-start-range supi_start_range | supi-stop-range supi_stop_range | gpsi-start-range gpsi_start_range | gpsi-stop-range gpsi_stop_range | pei-start-range pei_start_range | pei-stop-range pei_stop_range | operator-policy operator_policy_name ] 

gpsi-start-range gpsi_start_range

Specify the GPSI start range.

Must be an integer in the range of 1000000000-999999999999999.

gpsi-stop-range gpsi_stop_range

Specify the GPSI stop range.

Must be an integer in the range of 1000000000-999999999999999.

imsi-start-range imsi_start_range

Specify the IMSI start range.

Must be an integer in the range of 100000000000000-9999999999999999.

imsi-stop-range imsi_stop_range

Specify the IMSI stop range.

Must be an integer in the range of 100000000000000-9999999999999999.

operator-policy operator_policy_name

Specify name of the operator policy.

Must be a string.

pei-start-range pei_start_range

Specify the PEI start range.

Must be an integer in the range of 1000000000000-9999999999999999.

pei-stop-range pei_stop_range

Specify the PEI stop range.

Must be an integer in the range of 1000000000000-9999999999999999.

precedence precedence_number

Specify the precedence for entry.

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

sdt slice_differentiator_type

Specify the Slice Differentiator Type (SDT).

sst slice_service_type

Specify the Slice/Service Type (SST).

supi-start-range supi_start_range

Specify the SUPI start range.

Must be an integer in the range of 100000000000000-999999999999999.

supi-stop-range supi_stop_range

Specify the SUPI stop range.

Must be an integer in the range of 100000000000000-999999999999999.

Usage Guidelines

Use this command to configure operator policy selection match criteria definition.

policy subscriber list-entry imsi

Configures subscriber International Mobile Station Identification (IMSI).

Command Mode

Exec > Global Configuration (config) > Subscriber Policy Configuration (config-subscriber-policy_name ) > Subscriber Policy Precedence Configuration (config-subscriber-precedence )

Syntax

imsi mcc mobile_country_code mnc mobile_network_code 

mcc mobile_country_code

Specify the Mobile Country Code (MCC).

mnc mobile_network_code

Specify the Mobile Network Code (MNC).

Usage Guidelines

Use this command to configure subscriber IMSI.

policy subscriber list-entry imsi msin

Configures MSIN range for mobile subscriber identification number.

Command Mode

Exec > Global Configuration (config) > Subscriber Policy Configuration (config-subscriber-policy_name ) > Subscriber Policy Precedence Configuration (config-subscriber-precedence )

Syntax

imsi msin first start_msin_range last end_msin_range 

first start_msin_range

Specify starting value of the MSIN range.

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

last end_msin_range

Specify the ending value of the MSIN range.

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

Usage Guidelines

Use this command to configure MSIN range for mobile subscriber identification number.

policy subscriber list-entry serving-plmn

Configures serving PLMN parameters.

Command Mode

Exec > Global Configuration (config) > Subscriber Policy Configuration (config-subscriber-policy_name ) > Subscriber Policy Precedence Configuration (config-subscriber-precedence )

Syntax

serving-plmn [ mcc mobile_country_code | mnc mobile_network_code | mnc-list mnc_list ] 

mcc mobile_country_code

Specify the Mobile Country Code (MCC) portion of the PLMN ID.

mnc-list mnc_list

Specify the MNC list.

mnc mobile_network_code

Specify the Mobile Network Code (MNC) portion of the PLMN ID.

Usage Guidelines

Use this command to configure serving PLMN parameters.

policy sx-path-failure-detection

Configures Sx Path Failure Detection Policy-specific configuration.

Command Mode

Exec > Global Configuration (config)

Syntax

policy sx-path-failure-detection policy_name 

sx-path-failure-detection policy_name

Specify name of the Sx Path Failure Detection policy.

Must be a string.

Usage Guidelines

Use this command to configure Sx Path Failure Detection Policy-specific configuration.

policy sx-path-failure-detection ignore

Configures to ignore heartbeat-retry-failure or the heartbeat-recovery-timestamp-change configuration.

Command Mode

Exec > Global Configuration (config) > Sx Path Failure Detection Policy Configuration (config-sx-path-failure-detection-policy_name )

Syntax

ignore ignore_type 

ignore ignore_type

Specify to ignore heartbeat-retry-failure or the heartbeat-recovery-timestamp-change configuration.

Must be one of the following:

  • heartbeat-recovery-timestamp-change

  • heartbeat-retry-failure

Usage Guidelines

Use this command to configure ignoring the heartbeat-retry-failure or the heartbeat-recovery-timestamp-change configuration.

policy upf-selection

Configures UPF selection policy parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

policy upf-selection policy_name 

upf-selection policy_name

Specify name of the UPF selection policy.

Must be a string.

Usage Guidelines

Use this command to configure UPF selection policy parameters.

policy upf-selection list-entry

Configures UPF selection match criteria definition.

Command Mode

Exec > Global Configuration (config) > UPF Selection Policy Configuration (config-upf-selection-policy_name )

Syntax

precedence entry_precedence 

precedence entry_precedence

Specify the precedence for entry.

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

Usage Guidelines

Use this command to configure UPF selection match criteria definition.

policy upf-selection list-entry query-params

Configures the query parameter for UPF selection.

Command Mode

Exec > Global Configuration (config) > UPF Selection Policy Configuration (config-upf-selection-policy_name ) > UPF Selection Policy Precedence Configuration (config-upf-selection-precedence )

Syntax

query-params query_params 

query-params query_params

Specify the query parameters. If both pdn-type-subscription and pdn-type-session are configured, pdn-type-subscription will be considered.

Must be one of the following:

  • dcnr

  • dnn

  • location

  • pdn-type-session

  • pdn-type-subscription

  • slice

Usage Guidelines

Use this command to configure the query parameter for UPF selection.

profile content-filtering category database

Configures the Content Filtering database parameter.

Command Mode

Exec > Global Configuration (config)

Syntax

content-filtering category database max-versions max_versions 

max-versions max_versions

Specify the maximum number of Content-Filtering database versions.

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

Usage Guidelines

Use this command to configure the Content Filtering database parameter.

profile content-filtering category database directory

Configures the Content Filtering database directory parameter.

Command Mode

Exec > Global Configuration (config)

Syntax

content-filtering category database directory path cf_directory_path 

path cf_directory_path

Specify the Content-Filtering directory path.

Must be a string of 1-255 characters.

Usage Guidelines

Use this command to configure the Content Filtering database directory parameter.

profile converged-core supported-features

Enables the supported features for a rolling upgrade and Enhanced PFCP Association Release.

Command Mode

Exec > Global Configuration (config) > Converged Core (config-converged-core cc_profile_name )

Syntax

profile converged-core cc_profile_name  supported-features [ app-rx-retx-cache | app-tx-retx | epfar | rolling-upgrade-all | rolling-upgrade-enhancement-infra ] 

supported-features [ app-rx-retx-cache | app-tx-retx | rolling-upgrade-all | rolling-upgrade-enhancement-infra ]

Specify one of following options to enable the supported features for the rolling upgrade.

  • app-rx-retx-cache : Enable retransmission cache for inbound messages at application.

  • app-tx-retx : Enable retransmission for outbound messages at application.

  • rolling-upgrade-all : Enable the rolling-upgrade-enhancement-infra , app-rx-retx-cache , and app-tx-retxrolling upgrade features.

  • rolling-upgrade-enhancement-infra : Enable infra level features.


Note


By default, the rolling upgrade features are disabled.


supported-features epfar

Specify the epfar option to enable the support for Enhanced PFCP Association Release.


Note


By default, the epfar feature is disabled.


Usage Guidelines

Use this command to enable the supported features for a rolling upgrade and Enhanced PFCP Association Release.

profile dnn

Configures DNN profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile dnn dnn_profile_name [ always-on { false | true } | charging-profile profile_name | dcnr { false | true } | dnn-selection-mode dnn_selection_mode | dnn profile_name | emergency { false | true } | mode dnn_mode | only-nr-capable-ue { false | true } | pcc-ue-rule-precedence-mapping { false | true } | pcscf-profile profile_name | ppd-profile profile_name | presence-reporting { false | true } | qci-qos-profile qci_qos_profile | qos-profile profile_name | upf-selection-policy upf_selection_policy | userplane-inactivity-timer timeout_period | virtual-mac mac_address | wps-profile profile_name ] 

always-on { false | true }

Specify to enable or disable Always On PDU session.

Must be one of the following:

  • false

  • true

Default Value: false.

charging-characteristics-id cc_id

Specify the charging characteristics ID.

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

charging-profile profile_name

Specify name of the charging profile.

Must be a string.

charging-qbc-profile profile_name

Specify name of the charging QBC profile.

Must be a string.

dcnr { false | true }

Specify to enable or disable support for dual connectivity with new radio.

Must be one of the following:

  • false

  • true

Default Value: false.

dnn-selection-mode dnn_selection_mode

Specify the selection mode for subscription. The default mode is "verified".

Must be one of the following:

  • network-provided

  • ue-provided

  • verified

dnn dnn_profile_name

Specify name of the DNN profile.

Must be a string.

emergency { false | true }

Specify whether the DNN is emergency DNN or not.

Must be one of the following:

  • false

  • true

Default Value: false.

mode dnn_mode

Specify the DNN mode of operation.

Must be one of the following:

  • offline : Offline. DNN in offline mode, new sessions are rejected.

only-nr-capable-ue { false | true }

Specify whether to allow only 5G capable UE, and reject calls from non-5G capable UE.

Must be one of the following:

  • false

  • true

Default Value: false.

override profiles

Specify the list of profiles for local preference.

Must be one of the following:

  • charging-characteristics-id

  • charging-profile

  • charging-qbc-profile

pcc-ue-rule-precedence-mapping { false | true }

Specify whether to map PCC rule precedence to SMF-assigned TFT and auth rule precedence values. If disabled, values sent by PCF are used.

Must be one of the following:

  • false

  • true

Default Value: true.

pcscf-profile profile_name

Specify the P-CSCF profile association.

Must be a string.

ppd-profile profile_name

Specify the Paging-Policy differentition.

Must be a string.

presence-reporting { false | true }

Specify whether to enable or disable presence reporting for this DNN.

Must be one of the following:

  • false

  • true

Default Value: false.

qci-qos-profile qci_qos_profile

Specify the QCI QoS Profile configuration related to QCI to QoS mapping.

Must be a string.

qos-profile qos_profile

Specify the QoS Profile configuration.

Must be a string.

upf-selection-policy upf_selection_policy

Specify the UPF selection policy specific configuration.

Must be a string.

userplane-inactivity-timer timeout_period

Specify the user plane inactivity timer in seconds.

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

Default Value: 0.

virtual-mac mac_address

Specify the remote virtual MAC address used to generate interface ID for UE.

wps-profile profile_name

Specify name of the Wireless Priority Service (WPS) profile.

Must be a string.

Usage Guidelines

Use this command to configure the DNN profile. The CLI prompt changes to the DNN Profile Configuration mode (config-dnn-<profile_name>).

profile dnn accounting

Configures accounting parameters.

Command Mode

Exec > Global Configuration (config) > DNN Profile Configuration (config-dnn-profile_name )

Syntax

accounting server-group radius_server_group_name 

server-group radius_server_group_name

Specify name of the RADIUS server group.

Usage Guidelines

Use this command to configure the accounting parameters.

profile dnn authentication algorithm

Configures the authentication algorithm.

Command Mode

Exec > Global Configuration (config) > DNN Profile Configuration (config-dnn-profile_name )

Syntax

authentication algorithm { chap chap_preference | convert-to-mschap | mschap mschap_preference | pap pap_preference | password-use-pco } 

chap chap_preference

Specify the Challenge Handshake Authentication Protocol (CHAP) and preference. Lower value means higher preference. To disable, set it to 0.

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

Default Value: 0.

convert-to-mschap

Specify conversion of CHAP to MSCHAP when CHAP response length is 49 bytes.

mschap mschap_preference

Specify the Microsoft Challenge Handshake Authentication Protocol (MS-CHAP) and preference. Lower value means higher preference. To disable, set it to 0.

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

Default Value: 0.

pap pap_preference

Specify the Password Authentication Protocol (PAP) and preference. Lower value means higher preference. To disable, set it to 0.

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

Default Value: 0.

password-use-pco

Specify to override password with PCO password.

Usage Guidelines

Use this command to configure the authentication algorithm.

profile dnn authentication secondary

Configures the secondary authentication method.

Command Mode

Exec > Global Configuration (config) > DNN Profile Configuration (config-dnn-profile_name )

Syntax

authentication secondary radius group radius_server_group_name 

group radius_server_group_name

Specify name of the RADIUS server group.

radius

Specify to use RADIUS as secondary authentication method.

Usage Guidelines

Use this command to configure the secondary authentication method.

profile dnn authorization

Configures the authorization method.

Command Mode

Exec > Global Configuration (config) > DNN Profile Configuration (config-dnn-profile_name )

Syntax

authorization local [ rat-type rat_types ] 

local

Specify to use local policy configuration.

rat-type rat_types

Specify the RAT types.

Must be one of the following:

  • eutra

  • nr

  • wlan

Usage Guidelines

Use this command to configure the authorization method.

profile dnn dnn

Configures a Virtual DNN profile under a DNN profile and NF user list.

Command Mode

Exec > Global Configuration (config)

Syntax

dnn profile_name 

Usage Guidelines

Use this command to configure a DNN profile that is used to map a UE-requested DNN to a Virtual DNN. The SMF sends "Mapped" DNNs for configured network functions and "UE-requested" DNNs for other network functions. The UE-requested DNN is always sent on the N1 interface.

profile dnn ip source-violation

Configures the IP source violation detection feature.

Command Mode

Exec > Global Configuration (config)

Syntax

profile dnn profile_nameip source-violation 

Usage Guidelines

Use this command to configure the IP source violation detection feature.

profile dnn dnn nw-fu-conf

Configures network function parameters.

Command Mode

Exec > Global Configuration (config) > DNN Profile Configuration (config-dnn-profile_name )

Syntax

dnn dnn_name network-function-list nf_list 

dnn dnn_name

Specify name of the DNN.

Must be a string.

network-function-list nf_list

Specify the list of network functions that the selected DNN profile will be sent. The list of network functions supported are CHF, PCF, and UPF.

Must be a string.

Usage Guidelines

Configures a Virtual DNN profile under a DNN profile and NF user list. Use this command to configure the network function parameters.

profile dnn dnn rmgr-conf

Configures the RMGR parameters.

Command Mode

Exec > Global Configuration (config) > DNN Profile Configuration (config-dnn-profile_name )

Syntax

dnn rmgr rmgr_nf 

rmgr rmgr_nf

Specify the RMGR Network Function.

Must be a string.

Usage Guidelines

Use this command to configure the RMGR parameters.

profile dnn dns primary

Configures the primary DNS server details.

Command Mode

Exec > Global Configuration (config) > DNN Profile Configuration (config-dnn-profile_name )

Syntax

dns primary { ipv4 ipv4_address | ipv6 ipv6_address } 

ipv4 ipv4_address

Specify the primary DNS server's 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 primary DNS server's IPv6 address.

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

Usage Guidelines

Use this command to configure the primary DNS server details.

profile dnn dns secondary

Configures the secondary DNS server details.

Command Mode

Exec > Global Configuration (config) > DNN Profile Configuration (config-dnn-profile_name )

Syntax

dns secondary { ipv4 ipv4_address | ipv6 ipv6_address } 

ipv4 ipv4_address

Specify the secondary DNS server's 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 secondary DNS server's IPv6 address.

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

Usage Guidelines

Use this command to configure the secondary DNS server details.

profile dnn ims mark

Configures marking standard QCI value as IMS media.

Command Mode

Exec > Global Configuration (config) > DNN Profile Configuration (config-dnn-profile_name )

Syntax

ims mark qci qos_class_id 

qci qos_class_id

Specify the standard QoS Class Identifiers.

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

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

Usage Guidelines

Use this command to configure marking standard QCI value as IMS media.

profile dnn network-element-profiles

Configures network element profiles.

Command Mode

Exec > Global Configuration (config) > DNN Profile Configuration (config-dnn-profile_name )

Syntax

network-element-profiles { amf | chf | pcf | udm } profile_name 

amf profile_name

Specify name of the AMF network element profile. Changing the current profile name may impact existing calls. Requires DNN in offline mode.

Must be a string.

chf profile_name

Specify name of the CHF network element profile. Changing the current profile name may impact existing calls. Requires DNN in offline mode.

Must be a string.

pcf profile_name

Specify name of the PCF network element profile. Changing the current profile name may impact existing calls. Requires DNN in offline mode.

Must be a string.

udm profile_name

Specify name of the UDM network element profile. Changing the current profile name may impact existing calls. Requires DNN in offline mode.

Must be a string.

Usage Guidelines

Use this command to configure network element profiles. Changing the current profile name may impact existing calls. Requires DNN in offline mode.

profile dnn nexthop-forwarding-address

Configures the Redirect Service/NextHop IP address.

Command Mode

Exec > Global Configuration (config) > DNN Profile Configuration (config-dnn-profile_name )

Syntax

nexthop-forwarding-address { ipv4 ipv4_address | ipv6 ipv6_address } 

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.

Usage Guidelines

Use this command to configure the Redirect Service/NextHop IP address.

profile dnn nssai

Configures the default NSSAI configuration.

Command Mode

Exec > Global Configuration (config) > DNN Profile Configuration (config-dnn-profile_name )

Syntax

nssai { [ sd slice_differentiator ] [ sst slice_service_type ] } 

sd slice_differentiator

Specify the S-NSSAI Slice Differentiator (SD).

sst slice_service_type

Specify the S-NSSAI Slice/Service Type (SST).

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

Usage Guidelines

Use this command to configure the default NSSAI configuration.

profile dnn outbound

Configures DNN host password for PPP session authentication.

Command Mode

Exec > Global Configuration (config) > DNN Profile Configuration (config-dnn-profile_name )

Syntax

outbound password dnn_host_password 

password dnn_host_password

Specify the DNN host password.

Must be a string.

Usage Guidelines

Use this command to configure designating the DNN host password for PPP session authentication.

profile dnn primary-plmn

Configures the primary PLMN configuration.

Command Mode

Exec > Global Configuration (config) > DNN Profile Configuration (config-dnn-profile_name )

Syntax

primary-plmn { [ mcc mobile_country_code ] [ mnc mobile_network_code ] } 

Usage Guidelines

Use this command to configure the primary PLMN configuration.

profile dnn session type

Configures the PDU session type.

Command Mode

Exec > Global Configuration (config) > DNN Profile Configuration (config-dnn-profile_name )

Syntax

session type default_session_type [ allowed allowed_session_type ] 

allowed allowed_session_type

Specify the SMF allowed session types. Up to two allowed session types can be configured in addition to the default session type. The same session type cannot be configured both as allowed and default.

Must be one of the following:

  • IPV4

  • IPV4V6

  • IPV6

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

type default_session_type

Specify the default session type.

Must be one of the following:

  • IPV4

  • IPV4V6

  • IPV6

Usage Guidelines

Use this command to configure the PDU session type.

profile dnn ssc-mode

Configures Session and Service Continuity (SSC) Mode parameters.

Command Mode

Exec > Global Configuration (config) > DNN Profile Configuration (config-dnn-profile_name )

Syntax

ssc-mode default_ssc_mode [ allowed allowed_ssc_mode ] 

allowed allowed_ssc_mode

Specify the allowed SSC Modes. Up to two allowed modes can be configured in addition to the default SSC mode. The same SSC mode cannot be configured both as allowed and default.

Must be one of the following:

  • 1

  • 2

  • 3

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

ssc-mode default_ssc_mode

Specify the default SSC mode.

Must be one of the following:

  • 1

  • 2

  • 3

Usage Guidelines

Use this command to configure SSC mode parameters.

profile dnn timeout

Configures session time-to-live (TTL) configuration.

Command Mode

Exec > Global Configuration (config) > DNN Profile Configuration (config-dnn-profile_name )

Syntax

timeout { [ absolute max_duration ] [ backoff backoff_timer_duration ] [ cp-idle cp_idle_duration ] [ default-flow-only default_flow_only_duration ] [ jitter jitter_duration ] [ setup setup_duration ] [ up-idle up_idle_duration ] } 

absolute max_session_duration

Specify the maximum duration of the session in seconds, before the system automatically terminates the session. Value 0 indicates the function is disabled.

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

Default Value: 0.

backoff backoff_timer_duration

Specify the maximum duration in seconds for backoff timer during IP Exhaustion and N4 Path Failure cases.

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

Default Value: 0.

cp-idle cp_idle_duration

Specify the maximum duration after a 5G session has moved to idle (controlplane) state, before the system automatically terminates it. Value 0 indicates the function is disabled.

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

Default Value: 0.

default-flow-only default_flow_only_duration

Specify the maximum allowed duration for a PDU/PDN session to be in idle state, after which the system automatically terminates it. Value 0 indicates the function is disabled.

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

Default Value: 0.

jitter jitter_value

Specify the jitter value in seconds.

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

Default Value: 0.

setup max_setup_duration

Specify the maximum setup time duration in milliseconds, after which the system automatically aborts the request.

Must be an integer in the range of 5000-60000.

Default Value: 10000.

up-idle up_idle_duration

Specify the maximum duration after a 5G session has moved to idle (userplane) state, before the system automatically terminates it. Value 0 indicates the function is disabled.

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

Default Value: 0.

Usage Guidelines

Use this command to configure session time-to-live (TTL) configuration.

profile dnn upf

Configures the UPF APN profile.

Command Mode

Exec > Global Configuration (config) > DNN Profile Configuration (config-dnn-profile_name )

Syntax

upf apn apn_name 

apn apn_name

Specify name of the APN.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to configure the UPF APN profile.

profile dns-proxy

Configures DNS proxy profile parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile dns-proxy [ cache-ttl ttl | query-type query_type | randomize-answers | round-robin-answers | timeout dns_timeout ] 

cache-ttl ttl

Specify the TTL value of DNS responses in cache, in seconds.

Must be an integer in the range of 60-86400.

query-type query_type

Specify the DNS query type.

Must be one of the following:

  • ipv4-ipv6

  • ipv4

  • ipv6

Default Value: ipv4.

randomize-answers

Specify to enable randomizing address fetch.

round-robin-answers

Specify to enable round-robin address fetch.

timeout dns_timeout

Specify the DNS timeout.

Must be an integer.

Default Value: 500.

Usage Guidelines

Use this command to enable and configure DNS proxy parameters.

profile dns-proxy servers

Configures DNS server parameters.

Command Mode

Exec > Global Configuration (config) > DNS Proxy Configuration (config-dns-proxy)

Syntax

servers dns_server_name [ ip dns_server_ip_address | port dns_server_port_number | priority dns_server_priority | protocol dns_server_protocol ] 

ip dns_server_ip_address

Specify the IP address of the DNS server.

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.

port dns_server_port_number

Specify the port number of the DNS server.

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

priority dns_server_priority

Specify the priority for the DNS server.

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

protocol dns_server_protocol

Specify the protocol type for the DNS server.

Must be one of the following:

  • tcp

  • udp

Default Value: tcp.

servers dns_server_name

Specify the name of the DNS server.

Must be a string.

Usage Guidelines

Use this command to configure the DNS server parameters.

profile emergency-profile

Configures emergency profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile emergency-profile emergency_profile_name [ udm-profile udm_profile_name ] 

emergency-profile emergency_profile_name

Specify name of the emergency profile.

Must be a string.

udm-profile udm_profile_name

Specify name of the UDM profile.

Must be a string.

Usage Guidelines

Use this command to configure emergency profiles.

profile failure-handling

Configures the Failure Handling profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile failure-handling profile_name 

failure-handling profile_name

Specify name of the Failure Handling profile.

Must be a string.

Usage Guidelines

Use this command to configure the Failure Handling profile.

profile failure-handling interface gtpc message

Configures GTPC failure-handling template message types.

Command Mode

Exec > Global Configuration (config) > Failure Handling Profile Configuration (config-failure-handling-profile_name )

Syntax

interface gtpc message gtpc_message_type 

message gtpc_message_type

Specify the GTPC message type.

Must be one of the following:

  • S5S8CreateBearerReq

  • S5S8DeleteBearerReq

  • S5S8UpdateBearerReq

Usage Guidelines

Use this command to configure GTPC failure-handling template message types.

profile failure-handling interface gtpc message cause-code-type cause-code

Configures GTPC interface cause code types.

Command Mode

Exec > Global Configuration (config) > Failure Handling Profile Configuration (config-failure-handling-profile_name ) > GTPC Message Configuration (config-message-gtpc_message_type )

Syntax

cause-code gtpc_cause_code_type 

cause-code gtpc_cause_code_type

Specify the GTPC cause code type.

Must be one of the following:

  • temp-fail

Usage Guidelines

Use this command to configure GTPC interface cause code types.

profile failure-handling interface gtpc message cause-code-type cause-code action

Configures the action type for the cause.

Command Mode

Exec > Global Configuration (config) > Failure Handling Profile Configuration (config-failure-handling-profile_name ) > GTPC Message Configuration (config-message-gtpc_message_type ) > Cause Code Configuration (config-cause-code-cause_code )

Syntax

action action_type [ timeout retry_interval | max-retry max_retry ] 

action action_type

Specify the action type for the cause.

Must be one of the following:

  • clear

  • retry

  • terminate

max-retry max_retry

Specify the maximum retry count.

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

Default Value: 1.

timeout retry_interval

Specify the retry interval in milliseconds.

Must be an integer in the range of 1000-5000.

Default Value: 1000.

Usage Guidelines

Use this command to configure the action type for the cause.

profile failure-handling interface n11

Configures the N11 interface - SMF/PGW-C timer for reattempting bearer creation/updation.

Command Mode

Exec > Global Configuration (config) > Failure Handling Profile Configuration (config-failure-handling-profile_name )

Syntax

interface n11 

Usage Guidelines

Use this command to configure the N11 interface - SMF/PGW-C timer for reattempting bearer creation/updation.

profile failure-handling interface n11 message

Configures N11 message types.

Command Mode

Exec > Global Configuration (config) > Failure Handling Profile Configuration (config-failure-handling-profile_name ) > N11 Interface Configuration (config-n11)

Syntax

message message_type 

message message_type

Specify the N11 message type.

Must be one of the following:

  • n1n2transfer

Usage Guidelines

Use this command to configure n11 message types.

profile failure-handling interface n11 message cause-code-value cause-code

Configures the N11 interface cause code types.

Command Mode

Exec > Global Configuration (config) > Failure Handling Profile Configuration (config-failure-handling-profile_name ) > N11 Interface Configuration (config-n11) > n1n2transfer Message Configuration (config-message-n1n2transfer)

Syntax

cause-code n11_cause_code_type 

cause-code n11_cause_code_type

Specify the N11 interface cause code type.

Must be one of the following:

  • temp-reject-handover

  • temp-reject-register

Usage Guidelines

Use this command to configure the N11 interface cause code types.

profile failure-handling interface n11 message cause-code-value cause-code action

Configures the action type for the cause.

Command Mode

Exec > Global Configuration (config) > Failure Handling Profile Configuration (config-failure-handling-profile_name ) > N11 Interface Configuration (config-n11) > n1n2transfer Message Configuration (config-message-n1n2transfer) > Cause Code Configuration (config-cause-code-temp-cause_code )

Syntax

action action_type [ timeout retry_interval | max-retry max_retry ] 

action action_type

Specify the action type for the cause.

Must be one of the following:

  • clear

  • retry

  • terminate

max-retry max_retry

Specify the maximum retry count.

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

Default Value: 1.

timeout retry_interval

Specify the retry interval in milliseconds.

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

Default Value: 300.

Usage Guidelines

Use this command to configure the action type for the cause.

profile failure-handling interface pfcp

Configures PFCP Failure Handling template.

Command Mode

Exec > Global Configuration (config) > Failure Handling Profile Configuration (config-failure-handling-profile_name )

Syntax

interface pfcp 

Usage Guidelines

Use this command to configure PFCP Failure Handling template.

profile failure-handling interface pfcp message

Configures PFCP message types.

Command Mode

Exec > Global Configuration (config) > Failure Handling Profile Configuration (config-failure-handling-profile_name ) > PFCP Interface Configuration (config-pfcp)

Syntax

message pfcp_message_type 

message pfcp_message_type

Specify the PFCP message type.

Must be one of the following:

  • N4SessionEstablishmentReq

  • N4SessionModificationReq

  • N4SessionReportReq

Usage Guidelines

Use this command to configure PFCP message types.

profile failure-handling interface pfcp message cause-code-type-est cause-code

Configures PFCP interface cause code types.

Command Mode

Exec > Global Configuration (config) > Failure Handling Profile Configuration (config-failure-handling-profile_name ) > PFCP Interface Configuration (config-pfcp) > PFCP Message Configuration (config-message-message_type )

Syntax

cause-code cause_code_type 

cause-code cause_code_type

Specify the cause code type.

Must be a string.

-Or-

Must be one of the following:

  • no-resource-available

  • no-response-received

  • pfcp-entity-in-congestion

  • reject

  • service-not-supported

  • system-failure

Usage Guidelines

Use this command to configure PFCP interface cause code types.

profile failure-handling interface pfcp message cause-code-type-est cause-code action

Configures the action type for the cause.

Command Mode

Exec > Global Configuration

Syntax

action action_type [ timeout retry_interval | max-retry max_retry_count ] 

action action_type

Specify the action type for the cause.

Must be one of the following:

  • retry-terminate

  • terminate

max-retry max_retry_count

Specify the maximum retry count for the retry-terminate action.

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

Default Value: 1.

Usage Guidelines

Use this command to configure the action type for the cause.

profile failure-handling interface pfcp message cause-code-type-mod cause-code

Configures PFCP interface cause code types.

Command Mode

Exec > Global Configuration (config) > Failure Handling Profile Configuration (config-failure-handling-profile_name ) > PFCP Interface Configuration (config-pfcp) > PFCP Message Configuration (config-message-message_type )

Syntax

cause-code-type-mod cause-code pfcp_cause_code_type 

cause-code pfcp_cause_code_type

Specify the PFCP cause code type.

Must be a string.

-Or-

Must be one of the following:

  • mandatory-ie-incorrect

  • no-resource-available

  • no-response-received

  • pfcp-entity-in-congestion

  • reject

  • session-ctx-not-found

Usage Guidelines

Use this command to configure the PFCP cause code type.

profile failure-handling interface pfcp message cause-code-type-mod cause-code action

Configures the action type for the cause.

Command Mode

Exec > Global Configuration

Syntax

action action_type 

action action_type

Specify the action type for the cause.

Must be one of the following:

  • terminate

Usage Guidelines

Use this command to configure the action type for the cause.

profile failure-handling interface pfcp message cause-code-type-sessreport cause-code

Configures the PFCP interface cause code types.

Command Mode

Exec > Global Configuration

Syntax

cause-code-type-sessreport cause-code cause_id 

cause-code cause_id

Specify the cause ID or a range of cause IDs separated by either hyphhen (-) or comma (,) or both.

Must be a string.

Usage Guidelines

Use this command to configure the PFCP interface cause-code types.

profile failure-handling interface pfcp message cause-code-type-sessreport cause-code action

Configures the action type for the cause.

Command Mode

Exec > Global Configuration

Syntax

action action_type 

action action_type

Specify the action type for the cause.

Must be one of the following:

  • ignore

  • terminate

Usage Guidelines

Use this command to configure the action type for the cause.

profile failure-handling interface sxa message

Configures Sxa message types.

Command Mode

Exec > Global Configuration

Syntax

sxa message sxa_message_type 

message sxa_message_type

Specify the Sxa message type.

Must be one of the following:

  • SessionEstablishmentReq

Usage Guidelines

Use this command to configure Sxa message types.

profile failure-handling interface sxa message cause-code-type-est cause-code

Configures Sxa interface cause code types.

Command Mode

Exec > Global Configuration

Syntax

cause-code sxa_cause_code_type 

cause-code sxa_cause_code_type

Specify the Sxa interface cause code type, or range of cause codes separated by either hyphen (-) or comma (,) or both.

Must be a string.

-Or-

Must be one of the following:

  • no-resource-available

  • no-response-received

  • pfcp-entity-in-congestion

  • reject

  • service-not-supported

  • system-failure

Usage Guidelines

Use this command to configure Sxa interface cause code types.

profile failure-handling interface sxa message cause-code-type-est cause-code action

Configures the action type for the cause.

Command Mode

Exec > Global Configuration

Syntax

action action_type [ timeout retry_interval | max-retry max_retry_count ] 

action action_type

Specify the action type for the cause.

Must be one of the following:

  • retry-terminate

  • terminate

max-retry max_retry_count

Specify the maximum retry count for the retry-terminate action.

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

Default Value: 1.

Usage Guidelines

Use this command to configure the action type for the cause.

profile n3-tunnel

Configures N3 tunnelling information profile configuration.

Command Mode

Exec > Global Configuration (config)

Syntax

profile n3-tunnel profile_name [ notify ] 

n3-tunnel profile_name

Specify name of the N3 tunnelling profile.

Must be a string.

notify

Specify to enable downlink data notification.

Usage Guidelines

Use this command to configure N3 tunnelling information profile configuration.

profile n3-tunnel buffer

Configures the buffering for downlink direction.

Command Mode

Exec > Global Configuration (config) > N3 Tunnel Profile Configuration (config-n3-tunnel-profile_name )

Syntax

buffer node 

buffer node

Specify to enable buffering.

Must be one of the following:

  • upf : Enables buffering in UPF.

Usage Guidelines

Use this command to configure buffering for downlink direction.

profile network-element upf

Configures the UPF profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile network-element upf upf_profile_name [ [ capacity lb_capacity ] [ dnn-list dnn_list ] [ downlink-data-buffer { false | true } ] [ downlink-data-report { false | true } ] [ mode mode_of_operation ] [ n4-peer-port port_number ] [ node-id node_id ] [ priority lb_priority ] [ upf-group-profile profile_name ] ] 

capacity lb_capacity

Specify the static capacity relative to other UPFs used for load balancing.

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

Default Value: 10.

dnn-list dnn_list

Specify the list of DNNs supported by the UPF node.

Must be a string.

downlink-data-buffer { false | true }

Specify to enable or disable buffering in UPF for downlink data.

Must be one of the following:

  • false

  • true

Default Value: true.

downlink-data-report { false | true }

Specify to enable or disable notification from UPF for downlink data.

Must be one of the following:

  • false

  • true

Default Value: true.

mode mode_of_operation

Specify the UPF mode of operation.

Must be one of the following:

  • offline

n4-peer-port port_number

Specify the UPF N4 peer port number.

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

Default Value: 8805.

node-id node_id

Specify the node ID for the UPF peer node.

Must be a string.

priority lb_priority

Specify the static priority relative to other UPFs used for load balancing.

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

Default Value: 1.

upf-group-profile profile_name

Specify name of the UPF Group profile.

Must be a string.

upf upf_profile_name

Specify name of the UPF peer.

Must be a string.

Usage Guidelines

Use this command to configure the UPF profile. When active profile is removed, clears if any existing sessions and upf will be un-associated. The CLI prompt changes to the UPF Profile Configuration mode (config-upf-<profile_name>).

profile network-element upf n4-peer-address

Configures the N4 peer address.

Command Mode

Exec > Global Configuration (config) > UPF Profile Configuration (config-upf-profile_name )

Syntax

n4-peer-address { [ ipv4-address ipv4_address ] [ ipv6-address ipv6_address ] } 

ipv4-address ipv4_address

Specify the N4 peer 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-address ipv6_address

Specify the N4 peer IPv6 address.

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

Usage Guidelines

Use this command to confgure the N4 peer address.

profile overload-exclude message-priority

Configures the overload exclude profile parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile overload-exclude overload_exclude_profile_name  dnn-list dnn_list arp-list arp_list qci-list qci_list message-priority { any | s5e | s11 | sxa } uptopriority_val  

profile overload-exclude overload_exclude_profile_name

Configures the overload exclude profile to exclude the messages from throttling.

Must be a string.

dnn-list dnn_list

Specifies the DNN list that cnSGWc should exclude from throttling once overload exclude profile name matches.

arp-list arp_list

Specifies the ARP list that cnSGWc should exclude from throttling once overload exclude profile name matches.

qci-list qci_list

Specifies the QCI list that cnSGWc should exclude from throttling once overload exclude profile name matches.

message-priority interface_type uptopriority_val

message-priority interface_type specifies the interface for which incoming messages will be excluded from throttling. cnSGWc supports overload exclusion from the following interfaces:

  • any

  • s5e

  • s11

  • sxa

uptopriority_val specifies the range (must be an integer) of message priority values in incoming messages, which cnSGW will exclude from throttling for specified interface type once the overload exclude profile name matches.

Usage Guidelines

Use this command to configure the overload exclude profile parameters. The CLI prompt changes to the overload exclude Profile Configuration mode (config-overload-exclude-<profile_name>).

profile ppd

Configures the Paging Policy Differentiation (PPD) profile configuration.

Command Mode

Exec > Global Configuration (config)

Syntax

ppd ppd_profile_name [ fqi 5qi_priority_levels ] 

fqi 5qi_priority_levels

Specify the range of 5qi priority levels.

Must be an integer.

-Or-

Must be a string.

ppd ppd_profile_name

Specify name of the PPD profile.

Must be a string.

Usage Guidelines

Use this command to configure the PPD profile configuration.

profile ppd dscp-list

Configures the Differentiated Services Code Point (DSCP) values.

Command Mode

Exec > Global Configuration (config) > PPD Configuration (config-ppd-profile_name )

Syntax

dscp dscp_value [ ppi ppi_value ] 

dscp dscp_value

Specify the DSCP value.

ppi ppi_value

Specify the Paging Policy Indicator (PPI) value.

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

Usage Guidelines

Use this command to configure the DSCP values.

profile qos

Configures the QoS profile configuration.

Command Mode

Exec > Global Configuration (config)

Syntax

profile qos qos_profile_name [ [ priority 5qi_priority ] [ qi5 qos_id ] ] 

priority 5qi_priority

Specify the 5QI priority level.

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

profile qos qos_profile_name

Specify name of the QoS profile.

Must be a string.

qi5 qos_id

Specify the ID for the authorized QoS parameters.

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

Usage Guidelines

Use this command to configure the QoS profile configuration.

profile qos ambr

Configures the Aggregate Maximum Bit Rate (AMBR).

Command Mode

Exec > Global Configuration (config) > QoS Profile Configuration (config-qos-profile_name )

Syntax

ambr { ul ambr_uplink_threshold | dl ambr_downlink_threshold } 

dl ambr_downlink_threshold

Specify the AMBR downlink threshold in bps, Kbps, Mbps, Gbps, or Tbps.

Must be a string in the pattern '[0-9]+.[0-9]+ (bps|Kbps|Mbps|Gbps|Tbps)'.

ul ambr_uplink_threshold

Specify the AMBR uplink threshold in bps, Kbps, Mbps, Gbps, or Tbps.

Must be a string in the pattern '[0-9]+.[0-9]+ (bps|Kbps|Mbps|Gbps|Tbps)'.

Usage Guidelines

Use this command to configure the AMBR.

profile qos arp

Configures the Allocation and Retention Priority (ARP) for the service data.

Command Mode

Exec > Global Configuration (config) > QoS Profile Configuration (config-qos-profile_name )

Syntax

arp priority-level priority_level [ preempt-cap preempttion_capability ] [ preempt-vuln preemption_vulnerability ] 

preempt-cap preempttion_capability

Specify the preemption capability.

Must be one of the following:

  • MAY_PREEMPT

  • NOT_PREEMPT

Default Value: MAY_PREEMPT.

preempt-vuln preemption_vulnerability

Specify the preemption vulnerability.

Must be one of the following:

  • NOT_PREEMPTABLE

  • PREEMPTABLE

Default Value: NOT_PREEMPTABLE.

priority-level priority_level

Specify the priority level.

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

Usage Guidelines

Use this command to configure the ARP for the service data.

profile qos dscp-map qi5

Configures the standard 5QI value.

Command Mode

Exec > Global Configuration (config) > QoS Profile Configuration (config-qos-profile_name )

Syntax

dscp-map qi5 standard_qci 

qi5 standard_qci

Specify the standard QCI value.

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

Usage Guidelines

Configures the 5QI to DSCP-Marking mapping. Use this command to configure the standard 5QI value.

profile qos dscp-map qi5 arp-priority-level

Configures the ARP priority level.

Command Mode

Exec > Global Configuration (config) > QoS Profile Configuration (config-qos-profile_name )

Syntax

arp priority-level arp_priority_level 

Command Mode

Exec > Global Configuration (config) > SGW QoS Profile Configuration (config-sgw-qos-profile-profile_name )

Syntax

dscp-map operator-defined-qci operator_defined_qci [ gbr arp-priority-level arp_priority_level ] 

arp-priority-level arp_priority_level

Specify the ARP priority level.

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

Usage Guidelines

Configures the type of the QCI to GBR. Use this command to configure the ARP priority level.

profile qos dscp-map qi5 arp-priority-level dscp-info

Configures the Differentiated Services Code Point (DSCP) type.

Command Mode

Exec > Global Configuration

Syntax

dscp-info type dscp_type 

dl-encap-copy-inner

Specify to copy the inner DSCP to outer.

dl-encap-dscp-marking dscp_marking

Specify the DSCP value to be applied to packets.

dl-encaps-header

Specify the DSCP value be applied to encaps header.

dl-ud-dscp dscp_marking

Specify the DSCP value to be applied to packets.

dl-ud-encap-copy-inner

Specify to copy the inner DSCP to outer.

dl-ud-encap-dscp dscp_marking

Specify the DSCP value to be applied to packets.

encsp-header

Specify the DSCP value to be applied to encaps header.

type dscp_type

Specify the DCSP type.

Must be one of the following:

  • downlink

  • uplink

user-datagram1

Specify the DSCP value be applied to user datagram.

Usage Guidelines

Configures the type of the QCI to GBR. Use this command to configure the DSCP type.

profile qos dscp-map qi5 arp-priority-level dscp-info user-datagram

Configures the Differentiated Services Code Point (DCSP) value to be applied to user datagram.

Command Mode

Exec > Global Configuration

Syntax

user-datagram ul-uD-dscp-marking dscp_marking 

ul-uD-dscp-marking dscp_marking

Specify the DSCP value to be applied to packets.

Usage Guidelines

Use this command to configure the DCSP value to be applied to user datagram.

profile qos dscp-map qi5 dscp-info

Configures the Differentiated Services Code Point (DSCP) type.

Command Mode

Exec > Global Configuration

Syntax

dscp-info type dscp_type 

dl-encap-copy-inner

Specify to copy the inner DSCP to outer.

dl-encap-dscp-marking dscp_marking

Specify the DSCP value to be applied to packets.

dl-encaps-header

Specify the DSCP value be applied to encaps header.

dl-ud-dscp dscp_marking

Specify the DSCP value to be applied to packets.

dl-ud-encap-copy-inner

Specify to copy the inner DSCP to outer.

dl-ud-encap-dscp dscp_marking

Specify the DSCP value to be applied to packets.

encsp-header

Specify the DSCP value to be applied to encaps header.

type dscp_type

Specify the DCSP type.

Must be one of the following:

  • downlink

  • uplink

user-datagram1

Specify the DSCP value be applied to user datagram.

Usage Guidelines

Configures the type of the QCI to GBR. Use this command to configure the DSCP type.

profile qos dscp-map qi5 dscp-info user-datagram

Configures the Differentiated Services Code Point (DCSP) value to be applied to user datagram.

Command Mode

Exec > Global Configuration

Syntax

user-datagram ul-uD-dscp-marking dscp_marking 

ul-uD-dscp-marking dscp_marking

Specify the DSCP value to be applied to packets.

Usage Guidelines

Use this command to configure the DCSP value to be applied to user datagram.

profile qos max

Configures the maximum data burst volume.

Command Mode

Exec > Global Configuration (config) > QoS Profile Configuration (config-qos-profile_name )

Syntax

max data-burst max_data_burst_volume 

data-burst max_data_burst_volume

Specify the maximum data burst volume.

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

Usage Guidelines

Use this command to configure the maximum data burst volume.

profile qos qos-enforcement

Configures flow-level QoS enforcement configuration.

Command Mode

Exec > Global Configuration (config) > QoS Profile Configuration (config-qos-profile_name )

Syntax

qos-enforcement flow-level 

flow-level

Specify flow-level QoS enforcement.

Usage Guidelines

Use this command to configure flow-level QoS enforcement configuration.

profile sgw

Configures the SGW network function profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile sgw sgw_profile_name
[
     charging-mode { gtpp | none } 
   | fqdn sgwc_fqdn
   | load-profile load_profile_name
   | locality locality_name 
   | overload-profile overload_profile_name
   | plmn-list [mcc | mnc] 
   | resmgr-batch-operation [ enable | disable ] 
   | subscriber-policy policy_name 
   | session-idle-timer session_idle_timer  
   | timers session-expiration-in-secs timers_session_expiration_in_secs  
   | timers affinity-expiration-in-secs timers_affinity_expiration_in_secs  
   | timers session-dbsync-interval-in-ms timers_session-dbsync-interval-in-ms_in_secs  
 ] 

charging-mode { gtpp | none }

Specify the cnSGW-C charging mode for CDR generation.

gtpp: Indicates gtpp group profile name for CDR generation.

fqdn sgwc_fqdn

Specify the SGW-C Fully Qualified Domain Name (FQDN).

load-profile load_profile_name

Specify the name of the load profile.

locality locality_name

Specify the locality name for geo support.

overload-profile overload_profile_name

Specify the name of the overload profile.

plmn-list [mcc | mnc]

Specify the mobile country code (MCC) and the mobile network code (MNC).

resmgr-batch-operation [ enable | disable ]

Configure the batch operation as enable or disable.

subscriber-policypolicy_name

Specify the subscriber policy name.

session-idle-timer session_idle_timer

Specify the maximum duration in seconds for which a session remains idle.

timers session-expiration-in-secssession_expiration

Specify the duration for which the session is cached on service pod.

timers affinity-expiration-in-secsaffinity_expiration

Specify the duration for which the session affinity keys are valid on the service pod and other pods.

timers session-dbsync-interval-in-ms database_sync

Specify the duration after which the session is synchronized in the database.

profile sgw-qos-profile

Configures the SGW QoS profile configuration.

Command Mode

Exec > Global Configuration (config)

Syntax

profile sgw-qos-profile sgw_qos_profile_name 

sgw-qos-profile sgw_qos_profile_name

Specify name of the SGW QoS profile.

Must be a string.

Usage Guidelines

Use this command to configure the SGW QoS profile configuration.

profile sgw-qos-profile dscp-map operator-defined-qci

Configures the non-standard QCI values.

Command Mode

Exec > Global Configuration (config) > SGW QoS Profile Configuration (config-sgw-qos-profile-profile_name )

Syntax

dscp-map operator-defined-qci non_standard_qos_class_id 

operator-defined-qci non_standard_qos_class_id

Specify the non-standard QoS class identifier.

Must be an integer in the range of 128-254.

Usage Guidelines

Use this command to configure the non-standard QCI values.

profile sgw-qos-profile dscp-map operator-defined-qci gbr arp-priority-level

Configures the ARP priority level.

Command Mode

Exec > Global Configuration (config) > QoS Profile Configuration (config-qos-profile_name )

Syntax

dscp-map qi5 qci_name arp-priority-level arp_priority_level 

arp-priority-level arp_priority_level

Specify the ARP priority level.

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

Usage Guidelines

Configures the type of the QCI to GBR. Use this command to configure the ARP priority level.

profile sgw-qos-profile dscp-map operator-defined-qci gbr arp-priority-level dscp-info

Configures the Differentiated Services Code Point (DSCP) type.

Command Mode

Exec > Global Configuration

Syntax

dscp-info type dscp_type 

dl-encap-ci-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-ci-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-ci-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-co-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-co-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-co-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-copy-inner

Specify to copy the inner DSCP to outer.

dl-encap-copy-outer

Specify to copy the outer DSCP to inner.

dl-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-dscp-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-dscp-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

dl-iq-copy-outer

Specify to copy the outer DSCP to inner.

dl-iq-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

dl-iq-encap-type

Specify to copy the inner DSCP to outer.

dl-iq-encaps-header

Specify the DSCP value to be applied to encaps header.

dl-iq-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-iq-user-datagram

Specify DSCP value be applied to user datagram.

dl-priority dl_priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-ud-encap-copy-inner

Specify to copy the inner DSCP to outer.

dl-ud-encap-copy-outer

Specify to copy the outer DSCP to inner.

dl-ud-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

dl-ud-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-user-datagram

Specify DSCP value be applied to user datagram.

dscp-marking-dl dscp_value

Specify the DSCP value to be applied to packets.

type dscp_type

Specify the DCSP type.

Must be one of the following:

  • downlink

  • uplink

ul-encap-ci-dscp dscp_value

Specify the DSCP value to be applied to packets. A hexadecimal string starting with "0x". For example, 0x3F.

ul-encap-ci-priority ul_encap_ci_priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-ci-user-datagram

Specify DSCP value be applied to user datagram.

ul-encap-co-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-encap-co-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-co-user-datagram

Specify DSCP value be applied to user datagram.

ul-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-encap-dscp-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-dscp-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

ul-encap-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-encaps-header dscp_value

Specify the DCSP value to be applied to encaps header.

ul-iq-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-iq-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-iq-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-iq-encaps-header

Specify the DSCP value to be applied to encaps header.

ul-iq-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-iq-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

ul-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-ud-dscp dscp_value

Specify the DSCP value to be applied to packets. A hexadecimal string starting with 0x. For example, 0x3F.

ul-ud-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-ud-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-ud-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-ud-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

ul-ud-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

Usage Guidelines

Use this command to configure the DSCP type.

profile sgw-qos-profile dscp-map operator-defined-qci gbr dscp-info

Configures the Differentiated Services Code Point (DSCP) type.

Command Mode

Exec > Global Configuration

Syntax

dscp-info type dscp_type 

dl-encap-ci-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-ci-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-ci-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-co-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-co-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-co-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-copy-inner

Specify to copy the inner DSCP to outer.

dl-encap-copy-outer

Specify to copy the outer DSCP to inner.

dl-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-dscp-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-dscp-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

dl-iq-copy-outer

Specify to copy the outer DSCP to inner.

dl-iq-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

dl-iq-encap-type

Specify to copy the inner DSCP to outer.

dl-iq-encaps-header

Specify the DSCP value to be applied to encaps header.

dl-iq-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-iq-user-datagram

Specify DSCP value be applied to user datagram.

dl-priority dl_priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-ud-encap-copy-inner

Specify to copy the inner DSCP to outer.

dl-ud-encap-copy-outer

Specify to copy the outer DSCP to inner.

dl-ud-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

dl-ud-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-user-datagram

Specify DSCP value be applied to user datagram.

dscp-marking-dl dscp_value

Specify the DSCP value to be applied to packets.

type dscp_type

Specify the DCSP type.

Must be one of the following:

  • downlink

  • uplink

ul-encap-ci-dscp dscp_value

Specify the DSCP value to be applied to packets. A hexadecimal string starting with "0x". For example, 0x3F.

ul-encap-ci-priority ul_encap_ci_priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-ci-user-datagram

Specify DSCP value be applied to user datagram.

ul-encap-co-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-encap-co-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-co-user-datagram

Specify DSCP value be applied to user datagram.

ul-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-encap-dscp-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-dscp-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

ul-encap-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-encaps-header dscp_value

Specify the DCSP value to be applied to encaps header.

ul-iq-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-iq-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-iq-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-iq-encaps-header

Specify the DSCP value to be applied to encaps header.

ul-iq-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-iq-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

ul-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-ud-dscp dscp_value

Specify the DSCP value to be applied to packets. A hexadecimal string starting with 0x. For example, 0x3F.

ul-ud-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-ud-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-ud-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-ud-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

ul-ud-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

Usage Guidelines

Use this command to configure the DSCP type.

profile sgw-qos-profile dscp-map operator-defined-qci non-gbr

Configures the QCI type to non GBR.

Command Mode

Exec > Global Configuration

Syntax

non-gbr options 

Usage Guidelines

Use this command to configure the QCI type to non GBR.

profile sgw-qos-profile dscp-map operator-defined-qci non-gbr arp-priority-level

Configures the ARP priority level.

Command Mode

Exec > Global Configuration (config) > QoS Profile Configuration (config-qos-profile_name )

Syntax

dscp-map qi5 qci_name arp-priority-level arp_priority_level 

arp-priority-level arp_priority_level

Specify the ARP priority level.

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

Usage Guidelines

Configures the type of the QCI to GBR. Use this command to configure the ARP priority level.

profile sgw-qos-profile dscp-map operator-defined-qci non-gbr arp-priority-level dscp-info

Configures the Differentiated Services Code Point (DSCP) type.

Command Mode

Exec > Global Configuration

Syntax

dscp-info type dscp_type 

dl-encap-ci-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-ci-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-ci-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-co-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-co-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-co-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-copy-inner

Specify to copy the inner DSCP to outer.

dl-encap-copy-outer

Specify to copy the outer DSCP to inner.

dl-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-dscp-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-dscp-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

dl-iq-copy-outer

Specify to copy the outer DSCP to inner.

dl-iq-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

dl-iq-encap-type

Specify to copy the inner DSCP to outer.

dl-iq-encaps-header

Specify the DSCP value to be applied to encaps header.

dl-iq-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-iq-user-datagram

Specify DSCP value be applied to user datagram.

dl-priority dl_priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-ud-encap-copy-inner

Specify to copy the inner DSCP to outer.

dl-ud-encap-copy-outer

Specify to copy the outer DSCP to inner.

dl-ud-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

dl-ud-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-user-datagram

Specify DSCP value be applied to user datagram.

dscp-marking-dl dscp_value

Specify the DSCP value to be applied to packets.

type dscp_type

Specify the DCSP type.

Must be one of the following:

  • downlink

  • uplink

ul-encap-ci-dscp dscp_value

Specify the DSCP value to be applied to packets. A hexadecimal string starting with "0x". For example, 0x3F.

ul-encap-ci-priority ul_encap_ci_priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-ci-user-datagram

Specify DSCP value be applied to user datagram.

ul-encap-co-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-encap-co-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-co-user-datagram

Specify DSCP value be applied to user datagram.

ul-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-encap-dscp-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-dscp-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

ul-encap-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-encaps-header dscp_value

Specify the DCSP value to be applied to encaps header.

ul-iq-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-iq-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-iq-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-iq-encaps-header

Specify the DSCP value to be applied to encaps header.

ul-iq-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-iq-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

ul-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-ud-dscp dscp_value

Specify the DSCP value to be applied to packets. A hexadecimal string starting with 0x. For example, 0x3F.

ul-ud-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-ud-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-ud-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-ud-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

ul-ud-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

Usage Guidelines

Use this command to configure the DSCP type.

profile sgw-qos-profile dscp-map operator-defined-qci non-gbr dscp-info

Configures the Differentiated Services Code Point (DSCP) type.

Command Mode

Exec > Global Configuration

Syntax

dscp-info type dscp_type 

dl-encap-ci-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-ci-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-ci-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-co-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-co-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-co-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-copy-inner

Specify to copy the inner DSCP to outer.

dl-encap-copy-outer

Specify to copy the outer DSCP to inner.

dl-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-dscp-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-dscp-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

dl-iq-copy-outer

Specify to copy the outer DSCP to inner.

dl-iq-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

dl-iq-encap-type

Specify to copy the inner DSCP to outer.

dl-iq-encaps-header

Specify the DSCP value to be applied to encaps header.

dl-iq-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-iq-user-datagram

Specify DSCP value be applied to user datagram.

dl-priority dl_priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-ud-encap-copy-inner

Specify to copy the inner DSCP to outer.

dl-ud-encap-copy-outer

Specify to copy the outer DSCP to inner.

dl-ud-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

dl-ud-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-user-datagram

Specify DSCP value be applied to user datagram.

dscp-marking-dl dscp_value

Specify the DSCP value to be applied to packets.

type dscp_type

Specify the DCSP type.

Must be one of the following:

  • downlink

  • uplink

ul-encap-ci-dscp dscp_value

Specify the DSCP value to be applied to packets. A hexadecimal string starting with "0x". For example, 0x3F.

ul-encap-ci-priority ul_encap_ci_priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-ci-user-datagram

Specify DSCP value be applied to user datagram.

ul-encap-co-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-encap-co-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-co-user-datagram

Specify DSCP value be applied to user datagram.

ul-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-encap-dscp-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-dscp-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

ul-encap-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-encaps-header dscp_value

Specify the DCSP value to be applied to encaps header.

ul-iq-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-iq-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-iq-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-iq-encaps-header

Specify the DSCP value to be applied to encaps header.

ul-iq-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-iq-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

ul-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-ud-dscp dscp_value

Specify the DSCP value to be applied to packets. A hexadecimal string starting with 0x. For example, 0x3F.

ul-ud-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-ud-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-ud-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-ud-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

ul-ud-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

Usage Guidelines

Use this command to configure the DSCP type.

profile sgw-qos-profile dscp-map qci

Configures the standard QCI value.

Command Mode

Exec > Global Configuration (config) > SGW QoS Profile Configuration (config-sgw-qos-profile-profile_name )

Syntax

dscp-map qci standard_qos_class_id options 

qci standard_qos_class_id

Specify the standard QoS class identifier.

Must be an integer from the following: 1-9, 65, 66, 69, 70, 80, 82, 83.

Usage Guidelines

Use this command to configure the standard QCI value.

profile sgw-qos-profile dscp-map qci arp-priority-level

Configures the ARP priority level.

Command Mode

Exec > Global Configuration (config) > QoS Profile Configuration (config-qos-profile_name )

Syntax

dscp-map qi5 qci_name arp-priority-level arp_priority_level 

arp-priority-level arp_priority_level

Specify the ARP priority level.

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

Usage Guidelines

Configures the type of the QCI to GBR. Use this command to configure the ARP priority level.

profile sgw-qos-profile dscp-map qci arp-priority-level dscp-info

Configures the Differentiated Services Code Point (DSCP) type.

Command Mode

Exec > Global Configuration

Syntax

dscp-info type dscp_type 

dl-encap-ci-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-ci-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-ci-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-co-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-co-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-co-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-copy-inner

Specify to copy the inner DSCP to outer.

dl-encap-copy-outer

Specify to copy the outer DSCP to inner.

dl-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-dscp-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-dscp-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

dl-iq-copy-outer

Specify to copy the outer DSCP to inner.

dl-iq-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

dl-iq-encap-type

Specify to copy the inner DSCP to outer.

dl-iq-encaps-header

Specify the DSCP value to be applied to encaps header.

dl-iq-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-iq-user-datagram

Specify DSCP value be applied to user datagram.

dl-priority dl_priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-ud-encap-copy-inner

Specify to copy the inner DSCP to outer.

dl-ud-encap-copy-outer

Specify to copy the outer DSCP to inner.

dl-ud-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

dl-ud-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-user-datagram

Specify DSCP value be applied to user datagram.

dscp-marking-dl dscp_value

Specify the DSCP value to be applied to packets.

type dscp_type

Specify the DCSP type.

Must be one of the following:

  • downlink

  • uplink

ul-encap-ci-dscp dscp_value

Specify the DSCP value to be applied to packets. A hexadecimal string starting with "0x". For example, 0x3F.

ul-encap-ci-priority ul_encap_ci_priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-ci-user-datagram

Specify DSCP value be applied to user datagram.

ul-encap-co-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-encap-co-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-co-user-datagram

Specify DSCP value be applied to user datagram.

ul-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-encap-dscp-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-dscp-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

ul-encap-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-encaps-header dscp_value

Specify the DCSP value to be applied to encaps header.

ul-iq-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-iq-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-iq-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-iq-encaps-header

Specify the DSCP value to be applied to encaps header.

ul-iq-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-iq-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

ul-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-ud-dscp dscp_value

Specify the DSCP value to be applied to packets. A hexadecimal string starting with 0x. For example, 0x3F.

ul-ud-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-ud-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-ud-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-ud-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

ul-ud-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

Usage Guidelines

Use this command to configure the DSCP type.

profile sgw-qos-profile dscp-map qci default

Configures the default QCI parameter.

Command Mode

Exec > Global Configuration

Syntax

default options 

Usage Guidelines

Use this command to configure the default QCI parameter.

profile sgw-qos-profile dscp-map qci default dscp-info

Configures the Differentiated Services Code Point (DSCP) type.

Command Mode

Exec > Global Configuration

Syntax

dscp-info type dscp_type 

dl-encap-ci-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-ci-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-ci-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-co-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-co-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-co-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-copy-inner

Specify to copy the inner DSCP to outer.

dl-encap-copy-outer

Specify to copy the outer DSCP to inner.

dl-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-dscp-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-dscp-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

dl-iq-copy-outer

Specify to copy the outer DSCP to inner.

dl-iq-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

dl-iq-encap-type

Specify to copy the inner DSCP to outer.

dl-iq-encaps-header

Specify the DSCP value to be applied to encaps header.

dl-iq-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-iq-user-datagram

Specify DSCP value be applied to user datagram.

dl-priority dl_priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-ud-encap-copy-inner

Specify to copy the inner DSCP to outer.

dl-ud-encap-copy-outer

Specify to copy the outer DSCP to inner.

dl-ud-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

dl-ud-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-user-datagram

Specify DSCP value be applied to user datagram.

dscp-marking-dl dscp_value

Specify the DSCP value to be applied to packets.

type dscp_type

Specify the DCSP type.

Must be one of the following:

  • downlink

  • uplink

ul-encap-ci-dscp dscp_value

Specify the DSCP value to be applied to packets. A hexadecimal string starting with "0x". For example, 0x3F.

ul-encap-ci-priority ul_encap_ci_priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-ci-user-datagram

Specify DSCP value be applied to user datagram.

ul-encap-co-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-encap-co-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-co-user-datagram

Specify DSCP value be applied to user datagram.

ul-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-encap-dscp-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-dscp-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

ul-encap-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-encaps-header dscp_value

Specify the DCSP value to be applied to encaps header.

ul-iq-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-iq-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-iq-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-iq-encaps-header

Specify the DSCP value to be applied to encaps header.

ul-iq-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-iq-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

ul-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-ud-dscp dscp_value

Specify the DSCP value to be applied to packets. A hexadecimal string starting with 0x. For example, 0x3F.

ul-ud-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-ud-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-ud-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-ud-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

ul-ud-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

Usage Guidelines

Use this command to configure the DSCP type.

profile sgw-qos-profile dscp-map qci gbr dscp-info

Configures the Differentiated Services Code Point (DSCP) type.

Command Mode

Exec > Global Configuration

Syntax

dscp-info type dscp_type 

dl-encap-ci-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-ci-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-ci-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-co-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-co-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-co-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-copy-inner

Specify to copy the inner DSCP to outer.

dl-encap-copy-outer

Specify to copy the outer DSCP to inner.

dl-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-dscp-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-dscp-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

dl-iq-copy-outer

Specify to copy the outer DSCP to inner.

dl-iq-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

dl-iq-encap-type

Specify to copy the inner DSCP to outer.

dl-iq-encaps-header

Specify the DSCP value to be applied to encaps header.

dl-iq-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-iq-user-datagram

Specify DSCP value be applied to user datagram.

dl-priority dl_priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-ud-encap-copy-inner

Specify to copy the inner DSCP to outer.

dl-ud-encap-copy-outer

Specify to copy the outer DSCP to inner.

dl-ud-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

dl-ud-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-user-datagram

Specify DSCP value be applied to user datagram.

dscp-marking-dl dscp_value

Specify the DSCP value to be applied to packets.

type dscp_type

Specify the DCSP type.

Must be one of the following:

  • downlink

  • uplink

ul-encap-ci-dscp dscp_value

Specify the DSCP value to be applied to packets. A hexadecimal string starting with "0x". For example, 0x3F.

ul-encap-ci-priority ul_encap_ci_priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-ci-user-datagram

Specify DSCP value be applied to user datagram.

ul-encap-co-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-encap-co-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-co-user-datagram

Specify DSCP value be applied to user datagram.

ul-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-encap-dscp-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-dscp-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

ul-encap-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-encaps-header dscp_value

Specify the DCSP value to be applied to encaps header.

ul-iq-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-iq-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-iq-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-iq-encaps-header

Specify the DSCP value to be applied to encaps header.

ul-iq-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-iq-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

ul-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-ud-dscp dscp_value

Specify the DSCP value to be applied to packets. A hexadecimal string starting with 0x. For example, 0x3F.

ul-ud-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-ud-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-ud-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-ud-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

ul-ud-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

Usage Guidelines

Use this command to configure the DSCP type.

profile sgw-qos-profile dscp-map qci non-gbr dscp-info

Configures the Differentiated Services Code Point (DSCP) type.

Command Mode

Exec > Global Configuration

Syntax

dscp-info type dscp_type 

dl-encap-ci-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-ci-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-ci-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-co-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-co-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-co-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-copy-inner

Specify to copy the inner DSCP to outer.

dl-encap-copy-outer

Specify to copy the outer DSCP to inner.

dl-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

dl-encap-dscp-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-encap-dscp-user-datagram

Specify DSCP value be applied to user datagram.

dl-encap-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

dl-iq-copy-outer

Specify to copy the outer DSCP to inner.

dl-iq-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

dl-iq-encap-type

Specify to copy the inner DSCP to outer.

dl-iq-encaps-header

Specify the DSCP value to be applied to encaps header.

dl-iq-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-iq-user-datagram

Specify DSCP value be applied to user datagram.

dl-priority dl_priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

dl-ud-encap-copy-inner

Specify to copy the inner DSCP to outer.

dl-ud-encap-copy-outer

Specify to copy the outer DSCP to inner.

dl-ud-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

dl-ud-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

dl-user-datagram

Specify DSCP value be applied to user datagram.

dscp-marking-dl dscp_value

Specify the DSCP value to be applied to packets.

type dscp_type

Specify the DCSP type.

Must be one of the following:

  • downlink

  • uplink

ul-encap-ci-dscp dscp_value

Specify the DSCP value to be applied to packets. A hexadecimal string starting with "0x". For example, 0x3F.

ul-encap-ci-priority ul_encap_ci_priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-ci-user-datagram

Specify DSCP value be applied to user datagram.

ul-encap-co-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-encap-co-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-co-user-datagram

Specify DSCP value be applied to user datagram.

ul-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-encap-dscp-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-encap-dscp-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

ul-encap-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-encaps-header dscp_value

Specify the DCSP value to be applied to encaps header.

ul-iq-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-iq-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-iq-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-iq-encaps-header

Specify the DSCP value to be applied to encaps header.

ul-iq-ud-dscp dscp_value

Specify the DSCP value to be applied to packets.

ul-iq-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

ul-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-ud-dscp dscp_value

Specify the DSCP value to be applied to packets. A hexadecimal string starting with 0x. For example, 0x3F.

ul-ud-encap-copy-inner

Specify to copy the inner DSCP to outer.

ul-ud-encap-copy-outer

Specify to copy the outer DSCP to inner.

ul-ud-encap-dscp-marking dscp_value

Specify the DSCP value to be applied to packets.

ul-ud-encaps-header dscp_value

Specify the DSCP value to be applied to encaps header.

ul-ud-priority priority

Specify the priority.

Must be a string in the pattern '[0-7]{1}'.

ul-user-datagram dscp_value

Specify DSCP value be applied to user datagram.

Usage Guidelines

Use this command to configure the DSCP type.

profile upf-group

Configures the UPF group profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile upf-group upf_group_name [ dcnr { false | true } | location-area-group-list location_area_group_list | pdn-session-type pdn_session_type | slice-group-list slice_group_list ] 

dcnr { false | true }

Specify to enable or disable support for dual connectivity with new radio.

Must be one of the following:

  • false

  • true

Default Value: false.

location-area-group-list location_area_group_list

Specify the list of Location Area Group supported by UPF node.

Must be a string.

pdn-session-type pdn_session_type

Specify the list of PDN session type supported by UPF node.

Must be one of the following:

  • ipv4

  • ipv4v6

  • ipv6

slice-group-list slice_group_list

Specify the list of slice group supported by UPF node.

Must be a string.

upf-group upf_group_name

Specify name of the UPF group.

Must be a string.

Usage Guidelines

Use this command to configure the UPF group profile.

profile upf-group failure-profile

Configures the UPF Group failure profile.

Command Mode

Exec > Global Configuration (config) > UPF Group Profile Configuration (config-upf-group-profile_name )

Syntax

failure-profile failure_profile_name 

failure-profile failure_profile_name

Specify name of the UPF failure profile.

Must be a string.

Usage Guidelines

Use this command to configure the UPF Group failure profile.

profile upf-group heartbeat

Enables PFCP path management.

Command Mode

Exec > Global Configuration (config) > UPF Group Profile Configuration (config-upf-group-profile_name )

Syntax

heartbeat [ interval heartbeat_interval | retransmission-timeout retransmission_timeout | max-retransmissions max_retransmissions ] 

interval heartbeat_interval

Specify the heartbeat interval in seconds. To disable, set to 0.

Must be an integer from the following: 0, 60-360.

max-retransmissions max_retransmissions

Specify the maximum number retries for PFCP heartbeat request.

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

retransmission-timeout retransmission_timeout

Specify the heartbeat retransmission timeout period in seconds.

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

Usage Guidelines

Use this command to enable PFCP path management.

profile wps

Configures the Wireless Priority Service (WPS) profile parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

arp arp_level_range

Specify the range of ARP levels (separated by comma (,) or hyphen (-)).

Must be an integer.

-Or-

Must be a string.

message-priority message_priority

Specify the message priority for GTP-C and UP.

Must be one of the following:

  • gtpc

  • pfcp

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

wps wps_service_name

Specify name of the WPS service.

Must be a string.

Usage Guidelines

Use this command to configure the WPS profile parameters. The CLI prompt changes to the WPS Profile Configuration mode (config-wps-<profile_name>).

profile wps dscp

Configures the DSCP marking value for N3.

Command Mode

Exec > Global Configuration (config) > WPS Profile Configuration (config-wps-profile_name )

Syntax

dscp n3 dscp_marking_value sxa cp_dscp_marking s5e cp_dscp_marking s11 cp_dscp_marking 

n3 dscp_marking_value

Specify the UP DSCP marking value.

s11 cp_dscp_marking

Specify the CP DSCP marking value.

s5e cp_dscp_marking

Specify the CP DSCP marking value.

sxa cp_dscp_marking

Specify the CP DSCP marking value.

Usage Guidelines

Use this command to configure the DSCP marking value for N3.

clear subscriber

Clears subscriber data.

Command Mode

Exec

Syntax

clear subscriber { all | gr-instance gr_instance | imei imei_id | namespace namespace | nf-service nf_service | supi supi_id | config_specific_options } 

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.

Usage Guidelines

Use this command to clear subscriber data.

client http header

Configures HTTP header parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

client http header user-agent user_agent_header 

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.

Usage Guidelines

Use this command to configure HTTP header parameters.

client http ping

Configures HTTP ping parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

client http ping { [ timeout ping_timeout ] [ interval ping_interval ] } 

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.

Usage Guidelines

Use this command to configure HTTP ping parameters.

client inbound interface

Configures inbound client interface parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

client inbound interface interface_name 

interface interface_name

Specify name of the interface.

Usage Guidelines

Use this command to configure inbound client interface parameters. The CLI prompt changes to the Interface Configuration mode (config-interface-<interface_name>).

client inbound interface limit overload

Configures Overload configuration parameters.

Command Mode

Exec > Global Configuration (config) > Interface Configuration (config-interface-interface_name )

Syntax

limit overload reject-code response_code 

reject-code response_code

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

Must be an integer.

Usage Guidelines

Use this command to configure Overload configuration parameters.

client inbound interface limit pending

Configures pending limit configuration.

Command Mode

Exec > Global Configuration (config) > Interface Configuration (config-interface-interface_name )

Syntax

limit pending request max_pending_request_limit 

request max_pending_request_limit

Specify the maximum pending request limit to allow.

Must be an integer.

Default Value: 10240.

Usage Guidelines

Use this command to configure pending limit configuration.

client inbound limit overload

Configures Overload configuration parameters.

Command Mode

Exec > Global Configuration (config) > Interface Configuration (config-interface-interface_name )

Syntax

limit overload reject-code response_code 

reject-code response_code

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

Must be an integer.

Usage Guidelines

Use this command to configure Overload configuration parameters.

client inbound limit pending

Configures pending limit configuration.

Command Mode

Exec > Global Configuration (config) > Interface Configuration (config-interface-interface_name )

Syntax

limit pending request max_pending_request_limit 

request max_pending_request_limit

Specify the maximum pending request limit to allow.

Must be an integer.

Default Value: 10240.

Usage Guidelines

Use this command to configure pending limit configuration.

client outbound host ping

Configures outbound host ping parameter.

Command Mode

Exec > Global Configuration (config)

Syntax

client outbound host ping { [ timeout ping_timeout ] [ interval ping_interval ] [ backoff backoff_interval ] } 

Command Mode

Exec > Global Configuration (config) > Interface Configuration (config-interface-interface_name )

Syntax

host ping { [ timeout ping_timeout ] [ interval ping_interval ] } 

backoff backoff_interval

Specify, in milliseconds, the backoff time interval to wait when remote host was detected down before start 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, in milliseconds, the ping timeout duration to detect remote host down.

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

Default Value: 0.

Usage Guidelines

Use this command to configure outbound host ping parameter.

client outbound interface

Configures outbound client interface parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

client outbound interface interface_name 

interface interface_name

Specify the interface.

Usage Guidelines

Use this command to configure outbound client interface parameters. The CLI prompt changes to the Interface Configuration mode (config-interface-<interface_name>).

client outbound interface host ping

Configures outbound host ping parameter.

Command Mode

Exec > Global Configuration (config)

Syntax

client outbound host ping { [ timeout ping_timeout ] [ interval ping_interval ] [ backoff backoff_interval ] } 

Command Mode

Exec > Global Configuration (config) > Interface Configuration (config-interface-interface_name )

Syntax

host ping { [ timeout ping_timeout ] [ interval ping_interval ] } 

backoff backoff_interval

Specify, in milliseconds, the backoff time interval to wait when remote host was detected down before start 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, in milliseconds, the ping timeout duration to detect remote host down.

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

Default Value: 0.

Usage Guidelines

Use this command to configure outbound host ping parameter.

client outbound interface limit consecutive failure

Configures consecutive failure configuration parameters.

Command Mode

Exec > Global Configuration

Syntax

consecutive failure count failure_limit_count codes failure_codes 

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 failure_limit_count

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

Must be an integer.

Default Value: 0.

Usage Guidelines

Use this command to configure consecutive failure configuration parameters.

client outbound interface limit pending

Configures pending limit configuration.

Command Mode

Exec > Global Configuration (config)

Syntax

client outbound limit pending response response_message_limit 

Command Mode

Exec > Global Configuration (config) > Interface Configuration (config-interface-interface_name )

Syntax

pending response response_message_limit 

response response_message_limit

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

Must be an integer.

Default Value: 1024.

Usage Guidelines

Use this command to configure pending limit configuration.

client outbound limit consecutive failure

Configures consecutive failure configuration parameters.

Command Mode

Exec > Global Configuration

Syntax

consecutive failure count failure_limit_count codes failure_codes 

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 failure_limit_count

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

Must be an integer.

Default Value: 0.

Usage Guidelines

Use this command to configure consecutive failure configuration parameters.

client outbound limit pending

Configures pending limit configuration.

Command Mode

Exec > Global Configuration (config)

Syntax

client outbound limit pending response response_message_limit 

Command Mode

Exec > Global Configuration (config) > Interface Configuration (config-interface-interface_name )

Syntax

pending response response_message_limit 

response response_message_limit

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

Must be an integer.

Default Value: 1024.

Usage Guidelines

Use this command to configure pending limit configuration.

config-error info

Displays configuration error information.

Command Mode

Exec

Syntax

show config-error [ info ] 

Usage Guidelines

Use this command to view configuration error information.

datastore dbs

Configures DBS parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

datastore dbs dbs_name 

dbs dbs_name

Specify name of the DBS.

Must be a string.

Usage Guidelines

Use this command to configure the DBS parameters.

datastore dbs endpoints

Configures endpoint parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

datastore session-db endpoints host_name port port_number 

Command Mode

Exec > Global Configuration (config) > DBS Configuration (config-dbs-dbs_name )

Syntax

endpoints host_name port port_number 

endpoints host_name

Specify name of the host.

Must be a string.

port port_number

Specify the port number.

Must be an integer.

Usage Guidelines

Use this command to configure endpoint parameters.

datastore notification-ep

Configures notification endpoint parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

datastore notification-ep { [ host host_name ] [ port port_number ] } 

host host_name

Specify name of the host.

Must be a string.

port port_number

Specify the port number.

Must be an integer.

Usage Guidelines

Use this command to configure notification endpoint parameters.

datastore session-db

Configures Session DB parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

datastore session-db slice-name slice_name 

slice-name slice_name

Specify name of the slice.

Must be a string.

Usage Guidelines

Use this command to configure Session DB parameters.

datastore session-db endpoints

Configures endpoint parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

datastore session-db endpoints host_name port port_number 

Command Mode

Exec > Global Configuration (config) > DBS Configuration (config-dbs-dbs_name )

Syntax

endpoints host_name port port_number 

endpoints host_name

Specify name of the host.

Must be a string.

port port_number

Specify the port number.

Must be an integer.

Usage Guidelines

Use this command to configure endpoint parameters.

deployment

Configures the deployment parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

deployment [ app-name application_name | cluster-name cluster_name | dc-name datacenter_name | logical-nf-instance-id logical_nf_instance_id | model deployment_model ] 

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.

Must be one of the following:

  • small

Usage Guidelines

Use this command to configure the deployment parameters.

deployment resource

Configures the deployment CPU resource parameter.

Command Mode

Exec > Global Configuration (config) > Deployment Configuration (config-deployment)

Syntax

resource cpu cpu_size 

cpu cpu_size

Specify the CPU size in millicores.

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

Default Value: 18000.

Usage Guidelines

Use this command to configure the deployment CPU resource parameter.

diagnostics info

Displays diagnostics information.

Command Mode

Exec

Syntax

show diagnostics [ info ] 

Usage Guidelines

Use this command to view diagnostics information.

dump transactionhistory

Creates dump of transaction history.

Command Mode

Exec

Syntax

dump transactionhistory 

Usage Guidelines

Use this command to create dump of transaction history.

edr

Configures EDR parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

edr { [ reporting reporting_status ] [ subscribers subscribers_edr_reporting ] } 

reporting reporting_status

Specify to enable or disable EDR reporting.

Must be one of the following:

  • disable

  • enable

Default Value: disable.

subscribers subscribers_edr_reporting

Specify the subscribers for whom EDR reporting must be enabled.

Must be a string.

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

Usage Guidelines

Use this command to configure EDR parameters.

edr file files

Configures EDR file parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

edr file { transaction | transaction-collision } [ reporting reporting_status ] [ verbose verbosity_status ] 

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.

{ transaction | transaction-collision }

Specify name of the EDR file.

Usage Guidelines

Use this command to configure EDR file parameters.

edr file files disable

Disables procedure IDs.

Command Mode

Exec > Global Configuration (config) > EDR File Configuration (config-file-transaction_transaction-collision )

Syntax

disable procedure-id procedure_ids 

procedure-id procedure_ids

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

Must be a string.

Usage Guidelines

Use this command to disable specific procedure IDs.

edr file files flush

Configures EDR file flush parameters.

Command Mode

Exec > Global Configuration (config) > EDR File Configuration (config-file-transaction_transaction-collision )

Syntax

flush interval file_flush_interval 

interval file_flush_interval

Specify, in milliseconds, the file flush interval.

Must be an integer.

Default Value: 1000.

Usage Guidelines

Use this command to configure the EDR file flush parameters.

edr file files limit

Configures EDR file limit parameters.

Command Mode

Exec > Global Configuration (config) > EDR File Configuration (config-file-transaction_transaction-collision )

Syntax

limit { [ count max_files_to_preserve ] [ size max_single_file_size ] } 

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.

Usage Guidelines

Use this command to configure the EDR file limit parameters.

edr file files procedure-id disable-event-id

Disables transaction-level procedure ID configuration.

Command Mode

Exec > Global Configuration (config) > EDR File Configuration (config-file-transaction_transaction-collision )

Syntax

procedure-id procedure_id 

procedure procedure_id

Specify the procedure ID value/name.

Must be a string.

Usage Guidelines

Use this command to disable transaction-level procedure ID configuration.

edr file files procedure-id disable-event-id disable-inner disable

Disables event IDs.

Command Mode

Exec > Global Configuration (config) > EDR File Configuration (config-file-transaction_transaction-collision ) > Procedure ID Configuration (config-procedure-id-procedure_id )

Syntax

disable event-id event_ids 

event-id event_ids

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

Must be a string.

Usage Guidelines

Use this command to disable event IDs.

edr file files procedure-id disable-event-id disable-inner event-id disable-field-id

Disables procedure-level event ID configuration.

Command Mode

Exec > Global Configuration (config) > EDR File Configuration (config-file-transaction_transaction-collision ) > Procedure ID Configuration (config-procedure-id-procedure_id )

Syntax

event-id event_id 

event event_id

Specify the event ID value/name.

Must be a string.

Usage Guidelines

Use this command to disable procedure-level event ID configuration.

edr file files procedure-id disable-event-id disable-inner event-id disable-field-id disable

Disables field IDs.

Command Mode

Exec > Global Configuration (config) > EDR File Configuration (config-file-transaction_transaction-collision ) > Procedure ID Configuration (config-procedure-id-procedure_id )

Syntax

disable field-id field_ids 

field-id field_ids

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

Must be a string.

Usage Guidelines

Use this command to disable field IDs.

endpoint all

Displays endpoint status.

Command Mode

Exec

Syntax

show endpoint [ all ] 

Usage Guidelines

Use this command to view the status of endpoints.

endpoint info

Displays endpoint information.

Command Mode

Exec

Syntax

show endpoint info [ endpoint_name | endpoint_address | Interface interface_name | grInstance gr_instance_id | internal type_of_endpoint | startTime start_time | status endpoint_status | stoppedTime stop_time | type endpoint_type ] 

Interface interface_name

Specify the interface name of the endpoint.

Must be a string.

grInstance gr_instance_id

Specify the GR instance ID.

Must be a string.

internal type_of_endpoint

Specify whether the endpoint is of internal or external type.

Must be a string.

startTime start_time

Specify the time at which the endpoint started.

Must be a string.

status endpoint_status

Specify the current status of the endpoint.

Must be a string.

stoppedTime stop_time

Specify the time at which the endpoint stopped.

Must be a string.

type endpoint_type

Specify the endpoint type.

Must be a string.

endpoint_address

Specify the host address and port number.

Must be a string.

endpoint_name

Specify the name of the endpoint.

Must be a string.

Usage Guidelines

Use this command to view endpoint information.

geo maintenance

Configures Geo Admin Controller to enable or disable maintenance mode.

Command Mode

Exec

Syntax

maintenance enable { false | true } 

enable { 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.

Usage Guidelines

Use this command to configure Geo Admin Controller to enable or disable maintenance mode.

geo reset-role

Configures Geo Admin Controller for reset role.

Command Mode

Exec

Syntax

geo reset-role instance-id instance_id role new_role 

instance-id instance_id

Specify the instance ID for geo command.

role new_role

Specify the new role for the specified site.

Usage Guidelines

Use this command to configure Geo Admin Controller for reset role.

geo switch-role

Configures Geo Admin Controller for reset role.

Command Mode

Exec

Syntax

switch-role failback-interval failback_interval instance-id instance_id role new_role 

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.

Usage Guidelines

Use this command to configure Geo Admin Controller for reset role.

geomonitor podmonitor pods

Configures configuration of pods to be monitored.

Command Mode

Exec > Global Configuration (config)

Syntax

geomonitor podmonitor pods pod_name retryCount retry_count retryInterval retry_interval retryFailOverInterval retry_interval failedReplicaPercent failed_replica_precentage 

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.

Usage Guidelines

Use this command to configure configuration of pods to be monitored.

geomonitor remoteclustermonitor

Configures remote cluster monitoring parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

remoteclustermonitor retryCount retry_count retryInterval retry_interval 

retryCount retry_count

Specify the counter value to retry if remote clsuter is not reachable. To discable, 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 the remote site's status will be fetched.

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

Default Value: 3000.

Usage Guidelines

Use this command to configure remote cluster monitoring parameters.

geomonitor trafficMonitor

Configures traffic monitoring parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

trafficMonitor thresholdCount threshold_count thresholdInterval threshold_interval 

thresholdCount threshold_count

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

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.

Usage Guidelines

Use this command to configure traffic monitoring parameters.

geomonitor vipmonitor instance

Configures VIPs to be monitored.

Command Mode

Exec > Global Configuration (config)

Syntax

vipmonitor instance instance-id instance_id 

instance-id instance_id

Specify the instance ID.

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

Usage Guidelines

Configuration of VIPs to be monitored. Use this command to configure the instance ID.

geomonitor vipmonitor instance vips

Configures VIP interface parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

vips vipInterface vip_interface vipIp vip_ip vipPort vip_port retryCount retry_count retryInterval retry_interval retryFailOverInterval retry_failover_interval 

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_failover_interval

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

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

retryInterval retry_interval

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

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

vipInterface vip_interface

Specify the name of the interface to monitor.

Must be a string.

vipIp vip_ip

Specify the IPv4 address.

Must be a string.

vipPort vip_port

Specify the diagnostic port number.

Must be an integer.

Usage Guidelines

Use this command to configure VIP interface parameters.

infra metrics experimental

Configures the experimental configuration parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

infra metrics experimental version experimental_metrics_version 

version experimental_metrics_version

Specify the experimental metrics version to be enabled.

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

Default Value: 0.

Usage Guidelines

Use this command to configure the experimental configuration parameters.

infra metrics verbose verboseLevels

Configures verbose configuration parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

infra metrics verbose podType pod_type level verbose_level 

level verbose_level

Specify the verbosity level.

Must be one of the following:

  • debug

  • production

  • trace

Default Value: trace.

podType pod_type

Specify the pod type.

Must be one of the following:

  • load-balancer

  • protocol

  • service

Usage Guidelines

Use this command to configure verbose configuration parameters.

infra transaction limit

Configures the maximum stage limit per transaction.

Command Mode

Exec > Global Configuration (config)

Syntax

infra transaction limit stage max_stage_limit 

stage max_stage_limit

Specify the maximum stage limit per transaction.

Must be an integer.

Default Value: 100.

Usage Guidelines

Use this command to configure the maximum stage limit per transaction.

infra transaction limit consecutive same

Configures the maximum consecutive stage limit per transaction.

Command Mode

Exec > Global Configuration (config)

Syntax

infra transaction limit consecutive same stage max_consecutive_stage_limit 

stage max_consecutive_stage_limit

Specify the maximum consecutive stage limit per transaction.

Must be an integer.

Default Value: 10.

Usage Guidelines

Use this command to configure the maximum consecutive stage limit per transaction.

infra transaction loop

Configures the transaction loop detection parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

infra transaction loop detection detection_status 

detection detection_status

Specify to enable or disable loop detection.

Must be one of the following:

  • disable

  • enable

Default Value: disable.

Usage Guidelines

Use this command to configure the transaction loop detection parameter.

infra transaction loop category

Configures the loop category.

Command Mode

Exec > Global Configuration (config)

Syntax

infra transaction loop category loop_category 

category loop_category

Specify the category.

Usage Guidelines

Use this command to configure the loop category.

infra transaction loop category threshold

Configures the loop detection interval parameter.

Command Mode

Exec > Global Configuration (config)

Syntax

infra transaction threshold interval loop_detect_interval 

interval loop_detect_interval

Specify, in seconds, the loop detection interval.

Must be an integer.

Default Value: 5.

Usage Guidelines

Use this command to configure the loop detection interval parameter.

infra transaction loop category threshold thresholds

Configures thresholds.

Command Mode

Exec > Global Configuration

Syntax

thresholds threshold_level count max_transactions action threshold_action 

action threshold_action

Specify the action to take on threshold breach.

Must be one of the following:

  • kill-session

  • log-event

  • noop

Default Value: noop.

count max_transactions

Specify the maximum number of transactions for the threshold interval.

Must be an integer.

Default Value: 100.

thresholds threshold_level

Specify the threshold level.

Must be one of the following:

  • high

  • low

Usage Guidelines

Use this command to configure thresholds.

instance instance-id

Configures instance ID.

Command Mode

Exec > Global Configuration (config)

Syntax

instance instance-id instance_id 

id instance_id

Specify the instance ID.

Usage Guidelines

Use this command to configure the instance ID. The CLI prompt changes to the Instance ID Configuration mode (config-instance-id-<instance_id>).

instance instance-id endpoint ep

Configures endpoint parameters.

Command Mode

Exec > Global Configuration (config) > Instance ID Configuration (config-instance-id-instance_id )

Syntax

endpoint endpoint_type [ instancetype instance_type | loopbackEth interface_name_host_ip | loopbackPort port_number | nodes node_replicas_for_resiliency | replicas replicas_per_node ] 

certificate-name certificate_alias_name

Specify the alias name for the certificate.

dscp dscp_value

Specify the DSCP value.

enable-cpu-optimization { false | true }

Specify whether to enable CPU optimization in PFCP and GTP protocol message handling. By default, it is disabled.

Must be one of the following:

  • false

  • true

Default Value: false.

endpoint endpoint_type

Specify the endpoint type.

instancetype instance_type

Specify the endpoint local interface type.

Must be one of the following:

  • Dual

  • IPv4

  • IPv6

Default Value: IPv4.

internal-vip internal_vip

Specify the internal VIP.

Must be a string.

loopbackEth interface_name_host_ip

Specify the endpoint local interface name or host IP address.

Must be a string.

loopbackPort port_number

Specify the endpoint local port number.

Must be an integer.

nodes node_replicas_for_resiliency

Specify the number of node replicas for resiliency.

Must be an integer.

Default Value: 1.

replicas replicas_per_node

Specify the number of replicas per node.

Must be an integer.

Default Value: 1.

storage persistent_volume_storage_size

Specify the storage size of the persistent volume in gibibyte (GiB).

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

Default Value: 1.

uri-scheme uri_scheme

Specify the URI scheme.

Must be one of the following:

  • http

  • https

Default Value: http.

Usage Guidelines

Use this command to configure endpoint parameters.

instance instance-id endpoint ep cpu

Configures K8 pod CPU configuration.

Command Mode

Exec > Global Configuration

Syntax

cpu request cpu_resource_request max-process max_processes 

max-process max_processes

Specify the maximum number of parallel OS threads to use.

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

request cpu_resource_request

Specify the CPU resource request in millicores.

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

Usage Guidelines

Use this command to configure the K8 pod CPU configuration.

instance instance-id endpoint ep extended-service

Enables service pod to run on Session VM.

Command Mode

Exec > Global Configuration

Syntax

extended-service replicas replicas_per_node nodes node_replicas 

nodes node_replicas

Specify the number of node replicas for resiliency.

Must be an integer.

Default Value: 2.

replicas replicas_per_node

Specify the number of replicas per node.

Must be an integer.

Default Value: 2.

Usage Guidelines

Use this command to enable service pod to run on session VM. Service pods are spawned in Session VM.

instance instance-id endpoint ep heartbeat

Configures PFCP path management.

Command Mode

Exec > Global Configuration

Syntax

heartbeat interval heartbeat_interval max-retransmissions max_retransmissions retransmission-timeout retransmission_timeout 

interval heartbeat_interval

Specify the heartbeat interval in seconds.

Must be an integer from the following: 0, 60-360.

Default Value: 60.

max-retransmissions max_retransmissions

Specify the maximum number of retries for PFCP heartbeat request.

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

Default Value: 3.

retransmission-timeout retransmission_timeout

Specify the heartbeat retransmission timeout in seconds.

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

Default Value: 5.

Usage Guidelines

Use this command to configure PFCP path management.

instance instance-id endpoint ep interface

Configures the endpoint interface.

Command Mode

Exec > Global Configuration (config) > Instance ID Configuration (config-instance-id-instance_id ) > Endpoint endpoint_type Configuration (config-endpoint-endpoint_type )

Syntax

interface interface_type 

certificate-name certificate_alias_name

Specify the alias name for certificate.

dscp dscp_value

Specify the DSCP value.

instancetype ep_local_interface_type

Specify the endpoint local interface type.

Must be one of the following:

  • Dual

  • IPv4

  • IPv6

Default Value: IPv4.

interface interface_type

Specify the interface type.

loopbackEth pod_interface

Specify the pod interface.

Must be a string.

loopbackPort port_number

Specify the port number.

Must be an integer.

uri-scheme uri_scheme

Specify the URI scheme.

Must be one of the following:

  • http

  • https

Default Value: http.

Usage Guidelines

Use this command to configure the interface.

instance instance-id endpoint ep interface dispatcher

Displays the dispatcher queue support details for the interface.

Command Mode

Exec > Global Configuration (config) > Instance ID Configuration (config-instance-id-instance_id ) > Endpoint endpoint_type Configuration (config-endpoint-endpoint_type ) > Interface interface_type Configuration (config-interface-interface_type )

Syntax

dispatcher { cache { false | true } | capacity queue_capacity | count dispatcher_queues_count | expiry cache_entry_expiry_duration | nonresponsive cache_entry_expiry_duration | outbound { false | true } |rate-limit queue_rate_limit | threshold outstanding_requests_per_queue_cache } 

cache { false | true }

Specify to enable or disable disable retransmission cache support.

Must be one of the following:

  • false

  • true

Default Value: false.

capacity queue_capacity

Specify the capacity of each queue.

Must be an integer.

Default Value: 5000.

count dispatcher_queues_count

Specify the count of dispatcher queues.

Must be an integer.

Default Value: 0.

expiry cache_entry_expiry_duration

Specify, in milliseconds, the responded cache entry expiry duration.

Must be an integer.

Default Value: 60000.

nonresponsive cache_entry_expiry_duration

Specify, in milliseconds, the non-responsive cache entry expiry duration.

Must be an integer.

Default Value: 30000.

outbound { false | true }

Specify to enable or disable queue support for outbound messages.

Must be one of the following:

  • false

  • true

Default Value: true.

rate-limit queue_rate_limit

Specify the rate limit for each queue.

Must be an integer.

Default Value: 0.

threshold outstanding_requests_per_queue_cache

Specify the outstanding requests per queue cache.

Must be an integer.

Default Value: 30000.

Usage Guidelines

Use this command to view dispatcher queue support details for the interface.

instance instance-id endpoint ep interface echo

Configures GTP-C path management.

Command Mode

Exec > Global Configuration

Syntax

echo interval echo_interval retransmission-timeout retransmission_timeout max-retransmissions max_retransmissions 

interval echo_interval

Specify the echo interval in seconds.

Must be an integer in the range of 60-3600.

Default Value: 60.

max-retransmissions max_retransmissions

Specify the maximum number of retries for GTP echo request.

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

Default Value: 3.

retransmission-timeout retransmission_timeout

Specify the echo retransmission timeout in seconds.

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

Default Value: 5.

Usage Guidelines

Use this command to configure GTP-C path management.

instance instance-id endpoint ep interface heartbeat

Enables PFCP path management.

Command Mode

Exec > Global Configuration

Syntax

heartbeat interval heartbeat_interval retransmission-timeout retransmission_timeout max-retransmissions max_retransmissions 

interval heartbeat_interval

Specify the heartbeat interval in seconds. To disable, configure to 0.

Must be an integer from the following: 0, 1-3600.

Default Value: 60.

max-retransmissions max_retransmissions

Specify the maximum number of retries for PFCP heartbeat request.

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

Default Value: 4.

retransmission-timeout retransmission_timeout

Specify the heartbeat retransmission timeout in seconds.

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

Default Value: 5.

Usage Guidelines

Use this command to enable PFCP path management.

instance instance-id endpoint ep interface internal base-port

Configures the internal base-port to start endpoint parameter.

Command Mode

Exec > Global Configuration (config) > Instance ID Configuration (config-instance-id-instance_id ) > Endpoint endpoint_type Configuration (config-endpoint-endpoint_type )

Syntax

internal base-port start base_port_to_start_ep 

start base_port_to_start_ep

Specify the base port to start endpoint.

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

Usage Guidelines

Use this command to configure the internal base-port to start endpoint parameter.

instance instance-id endpoint ep interface overload-control client threshold critical

Configures critical threshold parameters for overload control protection.

Command Mode

Exec > Global Configuration

Syntax

critical critical_threshold action critical_threshold_action 

action critical_threshold_action

Specify the action to be taken when critical threshold limit is hit.

critical critical_threshold

Specify the critical threshold limit for outstanding requests.

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

Usage Guidelines

Use this command to configure critical threshold parameters for overload control protection.

instance instance-id endpoint ep interface overload-control client threshold high

Configures high threshold parameters for overload control protection.

Command Mode

Exec > Global Configuration

Syntax

high high_threshold action high_threshold_action 

action high_threshold_action

Specify the action to be taken when high threshold limit is hit.

high high_threshold

Specify the high threshold limit for outstanding requests.

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

Usage Guidelines

Use this command to configure high threshold parameters for overload control protection.

instance instance-id endpoint ep interface overload-control client threshold low

Configures low threshold parameters for overload control protection.

Command Mode

Exec > Global Configuration

Syntax

low low_threshold action low_threshold_action 

action low_threshold_action

Specify the action to be taken when low threshold limit is hit.

low low_threshold

Specify the low threshold limit for outstanding requests.

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

Usage Guidelines

Use this command to configure low threshold parameters for overload control protection.

instance instance-id endpoint ep interface overload-control endpoint threshold critical

Configures critical threshold parameters for overload control protection.

Command Mode

Exec > Global Configuration

Syntax

critical critical_threshold action critical_threshold_action 

action critical_threshold_action

Specify the action to be taken when critical threshold limit is hit.

critical critical_threshold

Specify the critical threshold limit for outstanding requests.

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

Usage Guidelines

Use this command to configure critical threshold parameters for overload control protection.

instance instance-id endpoint ep interface overload-control endpoint threshold high

Configures high threshold parameters for overload control protection.

Command Mode

Exec > Global Configuration

Syntax

high high_threshold action high_threshold_action 

action high_threshold_action

Specify the action to be taken when high threshold limit is hit.

high high_threshold

Specify the high threshold limit for outstanding requests.

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

Usage Guidelines

Use this command to configure high threshold parameters for overload control protection.

instance instance-id endpoint ep interface overload-control endpoint threshold low

Configures low threshold parameters for overload control protection.

Command Mode

Exec > Global Configuration

Syntax

low low_threshold action low_threshold_action 

action low_threshold_action

Specify the action to be taken when low threshold limit is hit.

low low_threshold

Specify the low threshold limit for outstanding requests.

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

Usage Guidelines

Use this command to configure low threshold parameters for overload control protection.

instance instance-id endpoint ep interface overload-control msg-type messageConfigs

Configures the message configuration parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

messageConfigs msg-type message_type msg-priority message_priority pending-request pending_requests priority message_priority queue-size queue_size rate-limit rate_limit reject-threshold reject_threshold reject-action reject-req 

msg-priority message_priority

Specify the priority of the message.

Must be one of the following:

  • high

  • low

msg-type message_type

Specify the message type.

Must be one of the following:

  • session-report —This message type is applicable for PFCP endpoint and Sxa interface.

  • create-session-request —This message type is applicable for GTP endpoint and S11 and S5 interfaces.

pending-request pending_requests

Specify the pending requests count in virtual queue.

Must be an integer.

priority message_priority

Specify the priority of messages to start rejecting if overload is reached.

Must be an integer.

queue-size queue_size

Specify the capacity of each virtual queue.

Must be an integer.

rate-limit rate_limit

Specify the rate limit for virtual queue.

Must be an integer.

reject-threshold reject_threshold

Specify the limit to reject incoming messages if this threshold percentage of pending requests are present.

Must be an integer.

reject-action reject-req

Specify to reject the create session request messages when the threshold reached for requests in virtual queue.

Usage Guidelines

Use this command to configure the message configuration parameters.


Important


If the rate limiting configuration is enabled for S11 or S5 interface, it will also apply to emergency calls and WPS sessions, potentially causing Create Session Request messages for these calls to be rejected or dropped.

instance instance-id endpoint ep interface path-failure

Configures the GTP Path Failure Detection Policy profile.

Command Mode

Exec > Global Configuration

Syntax

path-failure detection-policy detection_policy_name 

detection-policy detection_policy_name

Specify the failure detection policy name.

Must be a string.

Usage Guidelines

Use this command to configure the GTP Path Failure Detection Policy profile.

instance instance-id endpoint ep interface retransmission

Configures retransmission parameters.

Command Mode

Exec > Global Configuration

Syntax

retransmission timeout retransmission_interval max-retry max_retry 

max-retry max_retry

Specify the maximum number of times to request retry attempts. To disable retransmission, set to 0.

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

timeout retransmission_interval

Specify the retransmission interval in seconds. To disable retransmission, set to 0.

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

Usage Guidelines

Use this command to configure retransmission parameters.

instance instance-id endpoint ep interface secondary-ip

Configures secondary IP address used in FTIED creation for new requests.

Command Mode

Exec > Global Configuration

Syntax

secondary-ip list-entry secondary_ip_addresses 

list-entry secondary_ip_addresses

Specify the list of secondary IP addresses.

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.

Usage Guidelines

Use this command to configure secondary IP address used in FTIED creation for new requests.

instance instance-id endpoint ep interface sla

Configures the SLA parameters.

Command Mode

Exec > Global Configuration

Syntax

sla response response_time procedure procedure_time 

procedure procedure_time

Specify, in milliseconds, the procedure time.

Must be an integer in the range of 1000-120000.

response response_time

Specify, in milliseconds, the response time.

Must be an integer in the range of 1000-180000.

Usage Guidelines

Use this command to configure the SLA parameters.

instance instance-id endpoint ep interface supported-features

Enables supported features.

Command Mode

Exec > Global Configuration

Syntax

supported-features load-control overload-control 

load-control

Specify to enable load control.

overload-control

Specify to enable overload control.

Usage Guidelines

Use this command to enable supported features.

instance instance-id endpoint ep interface sx-path-failure

Configures the SX Path Failure Detection Policy profile.

Command Mode

Exec > Global Configuration

Syntax

sx-path-failure sx-detection-policy policy_profile_name 

sx-detection-policy policy_profile_name

Specify name of the SX Path Failure Detection Policy profile.

Must be a string.

Usage Guidelines

Use this command to configure the SX Path Failure Detection Policy profile.

instance instance-id endpoint ep interface vip

Configures the virtual IP address (VIP) parameters.

Command Mode

Exec > Global Configuration

Syntax

vip { vip-ip host_address | vip-port port_number } offline 

offline

Specify when the virtual IP address (VIP) is offline.

vip-interface interface_name

Specify the interface name to advertise BGP router.

Must be a string.

vip-ip host_address

Specify the host address.

Must be a string.

vip-port port_number

Specify the port number.

Must be an integer.

Usage Guidelines

Use this command to configure the VIP address parameters.

instance instance-id endpoint ep interface vip6

Configures VIP IP6 parameters.

Command Mode

Exec > Global Configuration

Syntax

vip6 vip-ip6 vip_ip6 vip-ipv6-port port_number offline 

offline

Specify the VIP IP as offline.

vip-ip6 vip_ip6

Specify the host detail.

Must be a string.

vip-ipv6-port port_number

Specify the port number.

Must be an integer.

Usage Guidelines

Use this command to configure VIP IP6 parameters.

instance instance-id endpoint ep internal base-port

Configures the internal base-port to start endpoint parameter.

Command Mode

Exec > Global Configuration (config) > Instance ID Configuration (config-instance-id-instance_id ) > Endpoint endpoint_type Configuration (config-endpoint-endpoint_type )

Syntax

internal base-port start base_port_to_start_ep 

start base_port_to_start_ep

Specify the base port to start endpoint.

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

Usage Guidelines

Use this command to configure the internal base-port to start endpoint parameter.

instance instance-id endpoint ep labels pod-config

Configures K8 node affinity label configuration.

Command Mode

Exec > Global Configuration

Syntax

pod-config key label_key value label_value 

key label_key

Specify the key for the label.

Must be a string.

value label_value

Specify the value of the label.

Must be a string.

Usage Guidelines

Use this command to configure the K8 node affinity label configuration.

instance instance-id endpoint ep memory

Configures K8 pod memory configuration.

Command Mode

Exec > Global Configuration

Syntax

memory request memory_request limit memory_limit 

limit memory_limit

Specify the maximum memory resource in use, in megabytes.

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

request memory_request

Specify the memory resource request, in megabytes.

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

Usage Guidelines

Use this command to configure the K8 pod memory configuration.

instance instance-id endpoint ep path-failure

Configures GTP path failure detection policy profile.

Command Mode

Exec > Global Configuration

Syntax

path-failure detection-policy detection_policy 

detection-policy detection_policy

Specify the detection policy profile.

Must be a string.

Usage Guidelines

Use this command to configure the GTP path failure detection policy profile.

instance instance-id endpoint ep retransmission

Configures retransmission parameters.

Command Mode

Exec > Global Configuration

Syntax

retransmission max-retry max_retry timeout retransmission_interval 

max-retry max_retry

Specify the maximum number of times to request retry attempts. To disable retransmission, set to 0.

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

Default Value: 3.

timeout retransmission_interval

Specify the retransmission interval in seconds. To disable retransmission, set to 0.

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

Default Value: 2.

Usage Guidelines

Use this command to configure retransmission parameters.

instance instance-id endpoint ep secondary-ip

Configures secondary IP address used in FTIED creation for new requests.

Command Mode

Exec > Global Configuration

Syntax

secondary-ip list-entry secondary_ip_addresses 

list-entry secondary_ip_addresses

Specify the list of secondary IP addresses.

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.

Usage Guidelines

Use this command to configure secondary IP address used in FTIED creation for new requests.

instance instance-id endpoint ep sla

Configures the response and procedure duration parameters.

Command Mode

Exec > Global Configuration

Syntax

sla response response_duration procedure procedure_duration 

procedure procedure_duration

Specify the procedure duration in milliseconds.

Must be an integer in the range of 1000-120000.

response response_duration

Specify the response duration in milliseconds.

Must be an integer in the range of 1000-120000.

Usage Guidelines

Use this command to configure the response and procedure duration parameters.

instance instance-id endpoint ep sx-path-failure

Configures Sx Path Failure Detection Policy Profile parameter.

Command Mode

Exec > Global Configuration

Syntax

sx-path-failure sx-detection-policy sx_detection_policy_name 

sx-detection-policy sx_detection_policy_name

Specify name of the Sx Path Failure Detection policy.

Must be a string.

Usage Guidelines

Use this command to configure the Sx Path Failure Detection Policy Profile parameter.

instance instance-id endpoint ep system-health-level crash

Configures system health crash parameters.

Command Mode

Exec > Global Configuration

Syntax

crash cpu-percent cpu_percentage memory-in-mbs memory num-of-goroutine goroutine_per_core 

cpu-percent cpu_percentage

Specify the CPU percentage.

Must be an integer.

Default Value: 80.

memory-in-mbs memory

Specify the memory in MBs.

Must be an integer.

Default Value: 2048.

num-of-goroutine goroutine_per_core

Specify the number of goroutine per core.

Must be an integer.

Default Value: 45000.

Usage Guidelines

Use this command to configure system health crash parameters.

instance instance-id endpoint ep system-health-level critical

Configures system health critical parameters.

Command Mode

Exec > Global Configuration

Syntax

critical cpu-percent cpu_percentage memory-in-mbs memory num-of-goroutine goroutine_per_core 

cpu-percent cpu_percentage

Specify the CPU percentage.

Must be an integer.

Default Value: 60.

memory-in-mbs memory

Specify the memory in MBs.

Must be an integer.

Default Value: 1024.

num-of-goroutine goroutine_per_core

Specify the number of goroutine per core.

Must be an integer.

Default Value: 35000.

Usage Guidelines

Use this command to configure system health critical parameters.

instance instance-id endpoint ep system-health-level warn

Configures system health warning parameters.

Command Mode

Exec > Global Configuration

Syntax

warn cpu-percent cpu_percentage memory-in-mbs memory num-of-goroutine goroutine_per_core 

cpu-percent cpu_percentage

Specify the CPU percentage.

Must be an integer.

Default Value: 50.

memory-in-mbs memory

Specify the memory in MBs.

Must be an integer.

Default Value: 512.

num-of-goroutine goroutine_per_core

Specify the number of goroutine per core.

Must be an integer.

Default Value: 25000.

Usage Guidelines

Use this command to configure system health warning parameters.

instance instance-id endpoint ep vip

Configures virtual IP (VIP) parameters.

Command Mode

Exec > Global Configuration (config) > Instance ID Configuration (config-instance-id-instance_id ) > Endpoint endpoint_type Configuration (config-endpoint-endpoint_type )

Syntax

vip-ip vip_ipv4_detail [ vip-port vip_port_number | vip-interface vip_interface_name | offline ] 

offline

Specify the VIP-IP as offline.

vip-interface vip_interface_name

Specify the interface name to advertise BGP router.

Must be a string.

vip-ip vip_ipv4_detail

Specify the IPv4 detail.

Must be a string.

vip-port vip_port_number

Specify the VIP port number.

Must be an integer.

Usage Guidelines

Use this command to configure VIP parameters.

instance instance-id endpoint ep vip6

Configures VIP IPv6 parameters.

Command Mode

Exec > Global Configuration (config) > Instance ID Configuration (config-instance-id-instance_id ) > Endpoint endpoint_type Configuration (config-endpoint-endpoint_type )

Syntax

vip-ipv6 vip_ipv6_detail [ vip-ipv6-port vip_ipv6_port_number | offline ] 

offline

Specify the VIP-IP as offline.

vip-ipv6-port vip_ipv6_port_number

Specify the port number.

Must be an integer.

vip-ipv6 vip_ipv6_detail

Specify the IPv6 detail.

Must be a string.

Usage Guidelines

Use this command to configure VIP IPv6 parameters.

instances instance

Configures instance configuration parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

instances instance instance_id system-id system_id cluster-id cluster_id slice-name slice_name 

cluster-id cluster_id

Specify the instance cluster ID.

Must be a string.

instance-id instance_id

Specify the instance ID.

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

slice-name slice_name

Specify the CDL slice name associated with instance ID.

Must be a string.

system-id system_id

Specify the instance system ID.

Must be a string.

Usage Guidelines

Use this command to configure instance configuration parameters.

k8 ccg

Configures coverage build parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

k8 ccg coverage-build { false | true } 

coverage-build { false | true }

Specify whether to enable or disable coverage build.

Must be one of the following:

  • false

  • true

Default Value: false.

Usage Guidelines

Use this command to configure the coverage build parameters.

k8 ccg coverage

Configures Code Coverage Utils parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

k8 ccg coverage container-stop container_stop 

container-stop container_stop

Specify container stop.

Must be a string.

Default Value: false.

Usage Guidelines

Use this command to configure the Code Coverage Utils parameters.

k8 label pod-group-config

Configures the K8 node affinity label parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

k8 label vm_group key label_key value label_value 

key label_key

Specify the label key.

Must be a string.

value label_value

Specify the label value.

Must be a string.

vm_group

Specify the VM group.

Must be one of the following:

  • cdl-layer

  • oam-layer

  • protocol-layer

  • service-layer

Usage Guidelines

Use this command to configure the K8 node affinity label parameters.

local-instance

Configures local instance parameters.

Command Mode

Exec > Global Configuration

Syntax

local-instance instance instance_id 

instance instance_id

Specify the local instance ID.

Usage Guidelines

Use this command to configure local instance parameters.

load factor

Configures the system load factor calculation parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

load factor { calc-frequency calc_frequency_time | exclude-pods exclude_pod_name }  

load factor

Configures the load factor calculation parameters.

{ calc-frequency calc_frequency_time

Configures the load factor frequency time.

Must be an integer.

| exclude-pods exclude_pod_name

Configures the specific app-infra pods to be excluded. It must be one of the following:

  • bfdmgr

  • bgpspeaker-pod

  • cache-pod

  • edr-monitor

  • georeplication-pod

Usage Guidelines

Use this command to configure the load factor for the system.

logging async application enable

Enables async logging.

Command Mode

Exec > Global Configuration

Syntax

enable buffer-size buffer_size 

buffer-size buffer_size

Specify the buffer size for async logging.

Must be an integer.

Usage Guidelines

Use this command to enable async logging.

logging async monitor-subscriber enable

Enables async logging.

Command Mode

Exec > Global Configuration

Syntax

enable buffer-size buffer_size 

buffer-size buffer_size

Specify the buffer size for async logging.

Must be an integer.

Usage Guidelines

Use this command to enable async logging.

logging async tracing enable

Enables async logging.

Command Mode

Exec > Global Configuration

Syntax

enable buffer-size buffer_size 

buffer-size buffer_size

Specify the buffer size for async logging.

Must be an integer.

Usage Guidelines

Use this command to enable async logging.

logging async transaction enable

Enables async logging.

Command Mode

Exec > Global Configuration

Syntax

enable buffer-size buffer_size 

buffer-size buffer_size

Specify the buffer size for async logging.

Must be an integer.

Usage Guidelines

Use this command to enable async logging.

logging error

Configures error logging parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

logging error stack status 

stack status

Specify to enable or disable error stack.

Must be one of the following:

  • disable

  • enable

Default Value: enable.

Usage Guidelines

Use this command to configure error logging parameters.

logging level

Configures the logging level.

Command Mode

Exec > Global Configuration (config)

Syntax

logging level { application application_log_level | monitor-subscriber monitor_subscriber_log_level | tracing tracing_log_level | transaction transaction_log_level } 

application application_log_level

Specify the log level for application log type.

Must be one of the following:

  • debug

  • error

  • info

  • off

  • trace

  • warn

monitor-subscriber monitor_subscriber_log_level

Specify the log level for subscriber monitoring.

Must be one of the following:

  • debug

  • error

  • info

  • off

  • trace

  • warn

tracing tracing_log_level

Specify the log level for tracing log type.

Must be one of the following:

  • debug

  • error

  • info

  • off

  • trace

  • warn

transaction transaction_log_level

Specify the log level for transaction log type.

Must be one of the following:

  • debug

  • error

  • info

  • off

  • trace

  • warn

Usage Guidelines

Configures logging parameters. Use this command to configure the logging level.

logging logger

Configures logger parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

logging name logger_name 

logger_name

Specify the logger name in the format "module.component.interface".

Must be a string.

Usage Guidelines

Use this command to configure logger parameters.

logging logger level

Configures the logging level.

Command Mode

Exec > Global Configuration

Syntax

logging name logger_name level { application application_log_level | tracing tracing_log_level | transaction transaction_log_level } 

application application_log_level

Specify the log level for application log type.

Must be one of the following:

  • debug

  • error

  • info

  • off

  • trace

  • warn

monitor-subscriber monitor_subscriber_log_level

Specify the log level for subscriber monitoring.

Must be one of the following:

  • debug

  • error

  • info

  • off

  • trace

  • warn

tracing tracing_log_level

Specify the log level for tracing log type.

Must be one of the following:

  • debug

  • error

  • info

  • off

  • trace

  • warn

transaction transaction_log_level

Specify the log level for transaction log type.

Must be one of the following:

  • debug

  • error

  • info

  • off

  • trace

  • warn

Usage Guidelines

Use this command to configure the logging level type.

logging transaction

Configures the transaction logging parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

logging transaction { duplicate { enable | disable } | max-file-size max_file_size | max-rotation max_rotations | message { enable | disable } | persist { enable | disable } } 

duplicate { enable | disable }

Specify whether to enable or disable duplicate logs in transaction logging.

Must be one of the following:

  • disable

  • enable

Default Value: disable.

max-file-size max_file_size

Specify the maximum transaction file size in MB.

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

Default Value: 50.

max-rotation max_max_rotations

Specify the maximum number of file rotations.

Must be an integer in the range of 2-1000.

Default Value: 10.

message { enable | disable }

Specify whether to enable or disable messages in transaction logging.

Must be one of the following:

  • disable

  • enable

Default Value: disable.

persist { enable | disable }

Specify whether to enable or disable file-based transaction logging.

Must be one of the following:

  • disable

  • enable

Default Value: disable.

Usage Guidelines

Use this command to configure the transaction logging parameters.

peers all

Displays the peer configuration information.

Command Mode

Exec

Syntax

show peers [ all ] 

Usage Guidelines

Use this command to view peer configuration information.

resource pod

Configures Pod resource parameter.

Command Mode

Exec > Global Configuration (config)

Syntax

pod podtype pod_type 

podtype pod_type

Specify the pod type.

Usage Guidelines

Use this command to configure Pod resource parameter.

resource pod cpu

Configures CPU resource request parameter.

Command Mode

Exec > Global Configuration (config) > Pod Resource Configuration (config-resource-pod_type )

Syntax

cpu request cpu_resource_request 

request cpu_resource_request

Specify the CPU resource request in millicores.

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

Usage Guidelines

Use this command to configure CPU resource request parameter.

resource pod labels

Configures K8 Node Affinity label configuration.

Command Mode

Exec > Global Configuration (config) > Pod Resource Configuration (config-resource-pod_type )

Syntax

labels key label_key value label_value 

key label_key

Specify the key for the label.

Must be a string.

value label_value

Specify the value for the label.

Must be a string.

Usage Guidelines

Use this command to configure K8 Node affinity label configuration.

resource pod memory

Configures memory resource request parameter.

Command Mode

Exec > Global Configuration (config) > Pod Resource Configuration (config-resource-pod_type )

Syntax

memory request memory_resource_request 

request memory_resource_request

Specify the memory resource request in megabytes.

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

Usage Guidelines

Use this command to configure memory resource request parameter.

resources info

Displays resource information.

Command Mode

Exec

Syntax

show resources [ info ] 

Usage Guidelines

Use this command to view information about the configured resources.

router bgplist

Configures BGP speaker configuration.

Command Mode

Exec > Global Configuration (config)

Syntax

router bgp bgp [ learnDefaultRoute { false | true } | loopbackBFDPort bfd_local_port_number | loopbackPort bgp_local_port_number ] 

bgp bgp

Specify the BGP.

Must be an integer.

learnDefaultRoute { false | true }

Specify whether to enable or disable learning default route and adding it in kernel space.

Must be one of the following:

  • false

  • true

Default Value: false.

loopbackBFDPort bfd_local_port_number

Specify the BFD local port number.

Must be an integer.

Default Value: 3784.

loopbackPort bgp_local_port_number

Specify the BGP local port number.

Must be an integer.

Default Value: 179.

Usage Guidelines

Use this command to configure the BGP speaker configuration.

router bgplist bfd

Configures BFD configuration.

Command Mode

Exec > Global Configuration (config) > Router Configuration (config-router-router )

Syntax

bfd { interval bfd_interval | min_rx bfd_min_rx | multiplier bfd_interval_multiplier } 

interval bfd_interval

Specify, in microseconds, the BFD interval.

Must be an integer.

Default Value: 250000.

min_rx bfd_min_rx

Specify, in microseconds, the BFD minimum RX.

Must be an integer.

Default Value: 250000.

multiplier bfd_interval_multiplier

Specify the BFD interval multiplier.

Must be an integer.

Default Value: 3.

Usage Guidelines

Use this command to configure the BFD configuration.

router bgplist interfaceList

Configures bonding interface configuration.

Command Mode

Exec > Global Configuration (config) > Router Configuration (config-router-router )

Syntax

interface bgp_local_interface 

interface bgp_local_interface

Specify the BGP local interface.

Must be a string.

Usage Guidelines

Use this command to configure the bonding interface configuration.

router bgplist interfaceList bondingInterfaces

Configures bonding interface configuration.

Command Mode

Exec > Global Configuration (config) > Router Configuration (config-router-router ) > Router Interface Configuration (config-router-interface )

Syntax

bondingInterface linked_bonding_interface 

bondingInterface linked_bonding_interface

Specify the linked bonding interface.

Must be a string.

Usage Guidelines

Use this command to configure the bonding interface configuration.

router bgplist interfaceList neighbors

Configures neighbor parameters.

Command Mode

Exec > Global Configuration (config) > Router Configuration (config-router-router ) > Router Interface Configuration (config-router-interface )

Syntax

neighbor neighbor_ip_address [ fail-over failover_type | remote-as remote_as_number ] 

fail-over failover_type

Specify the failover type.

Must be one of the following:

  • bfd

neighbor neighbor_ip_address

Specify the IP address of the neighbor.

Must be a string.

remote-as remote_as_number

Specify the Autonomous System (AS) number of the BGP neighbor.

Must be an integer.

Default Value: 65000.

Usage Guidelines

Use this command to configure the neighbor parameters.

router bgplist policies

Configures policy parameters.

Command Mode

Exec > Global Configuration (config) > Router Configuration (config-router-router )

Syntax

policy-name policy_name [ as-path-set as_path_set | gateWay gateway_address | interface interface | ip-prefix ip_prefix | isStaticRoute { false | true } | mask-range mask_range | modifySourceIp { false | true } ] 

as-path-set as_path_set

Specify the Autonomous System (AS) path set.

Must be a string.

gateWay gateway_address

Specify the gateway address.

Must be a string.

interface interface

Specify the interface to set as source ip.

Must be a string.

ip-prefix ip_prefix

Specify the IP prefix.

Must be a string.

isStaticRoute { false | true }

Specify whether to enable or disable adding static route into kernel space.

Must be one of the following:

  • false

  • true

Default Value: false.

mask-range mask_range

Specify the mask range.

Must be a string.

modifySourceIp { false | true }

Specify whether to enable or disable modifying source IP of incoming route.

Must be one of the following:

  • false

  • true

Default Value: false.

policy-name policy_name

Specify name of the policy.

Must be a string.

source-prefix source_ip_prefix

Specify the source IP prefix.

Must be a string.

Usage Guidelines

Use this command to configure the policy parameters.

rpc all

Displays RPC configuration information.

Command Mode

Exec

Syntax

show rpc [ all ] 

Usage Guidelines

Use this command to view RPC configuration information for all RPCs.

running-status info

Displays the system's current status information.

Command Mode

Exec

Syntax

show running-status [ info ] 

Usage Guidelines

Use this command to view the system's current status information.

sessions affinity

Displays the affinity count per instance.

Command Mode

Exec

Syntax

show sessions affinity 

Usage Guidelines

Use this command to view the affinity count per instance.

sessions commit-pending

Displays information for sessions for which the commits are in pending state.

Command Mode

Exec

Syntax

show sessions commit-pending 

Usage Guidelines

Use this command to view information for sessions that are pending commits.

show bfd-neigbor

Displays BFD status of neighbors.

Command Mode

Exec

Syntax

show bfd-neigbor [ ip ip_address ] 

ip ip_address

Specify the IP address of the neighbor.

Must be a string.

Usage Guidelines

Use this command to view BFD status of neighbors.

show bgp-global

Displays BGP global configuration.

Command Mode

Exec

Syntax

show bgp-global 

Usage Guidelines

Use this command to view BGP global configuration.

show bgp-kernel-route

Displays BGP kernel-configured routes.

Command Mode

Exec

Syntax

show bgp-kernel-route [ application { false | true } ] 

application { false | true }

Specify whether to display application added routes.

Must be one of the following:

  • false

  • true

Default Value: false.

Usage Guidelines

Use this command to view BGP kernel-configured routes.

show bgp-neighbors

Displays BGP neighbor's status.

Command Mode

Exec

Syntax

show bgp-neighbors [ ip ip_address ] 

ip ip_address

Specify the IP address of the neighbor.

Must be a string.

Usage Guidelines

Use this command to view BGP neighbor's status.

show bgp-route-summary

Displays BGP route summary.

Command Mode

Exec

Syntax

show bgp-route-summary 

Usage Guidelines

Use this command to view BGP route summary.

show bgp-routes

Displays BGP routes information.

Command Mode

Exec

Syntax

show bgp-routes 

Usage Guidelines

Use this command to view BGP routes information.

show edr

Displays EDR Transaction Procedure Event fields.

Command Mode

Exec

Syntax

show edr { [ event transaction_procedure_event ] [ transaction-procedure transaction_procedure ] } 

event transaction_procedure_event

Specify the transaction procedure event name/id/all.

Must be a string.

transaction-procedure transaction_procedure

Specify the transaction procedure name/id/all.

Must be a string.

Usage Guidelines

Use this command to view EDR Transaction Procedure Event fields.

show georeplication

Displays ETCD/Cache checksum.

Command Mode

Exec

Syntax

show georeplication checksum instance-id instance_id 

checksum

Specify checksum.

instance-id instance_id

Specify the instance ID for which checksum will be displayed.

Must be a string.

Usage Guidelines

Use this command to view ETCD/Cache checksum.

show role

Displays current role for the specified instance.

Command Mode

Exec

Syntax

show role instance-id instance_id 

instance-id instance_id

Specify the instance ID for which role must be displayed.

Usage Guidelines

Use this command to view current role for the specified instance.

show subscriber

Displays subscriber information.

Command Mode

Exec

Syntax

show subscriber { [ all ] [ gr-instance gr_instance ] [ imei imei_id ] [ nf-service nf_service ] [ supi supi_id ] [ config_specific_options ] } 

all

Specify all SUPIs or IMEIs.

gr-instance gr_instance

Specify the network function service under which to search.

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. Specify 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 the subscriber's SUPI ID.

Must be a string.

Usage Guidelines

Use this command to view subscriber information by SUPI, IMEI, or all.

show userplane userplane

Displays userplane information.

Command Mode

Exec

Syntax

show userplane all 

all

Specify all.

Usage Guidelines

Use this command to view userplane information.

aaa

Configures AAA-based user management parameters.

Command Mode

Exec

Syntax

aaa { authentication { users list_of_local_users admin change-password old-password user_password new-password user_password confirm-password user_password } } 

users list_of_local_users

Specify the user name.

Must be a string.

old-password user_password

Specify the user's current password.

Must be a string.

new-password user_password

Specify the user's new password.

Must be a string.

confirm-password user_password

Reenter the user's new password.

Must be a string.

Usage Guidelines

Use this command to configure the AAA based user management parameters.

cd

Configures the change directory command.

Command Mode

Exec

Syntax

cd directory.ssh  

directory

Specify the directory path.

Must be an alphanumeric string.

Usage Guidelines

Use this command to configure the change directory command.

cdl clear

Configures the Cisco Common Data Layer (CDL) parameters to delete the database sessions.

Command Mode

Exec

Syntax

cdl clear sessions [ db-name db_name | filter { condition { ends-with | match | starts-with } key key_value } | map-id map_id ] 

db-name db_name

Specifies the database name to be queried for deleting the data.

Must be a string of 1 to 16 characters.

key key_value

Specifies the query value.

Must be a string of 0 to 512 characters.

map-id map_id

Specifies the map ID to delete the data for a map.

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

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

Specify the query expression to filter the results of query.

Usage Guidelines

Use this command to delete the CDL database sessions.

cdl show sessions

Configures the CDL parameters to display the session details.

Command Mode

Exec

Syntax

cdl show sessions count { detailed { db-name db_name | filter { condition { ends-with | match | starts-with } | key key_value } | limit limit | map-id map_id } | summary { db-name db_name | filter { condition { ends-with | match | starts-with } | key key_value } | limit limit | map-id map_id } 

count

Display the session count information.

detailed

Display the session details with data.

summary

Display the session details without data.

db-name db_name

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

Must be a string of 1 to 16 characters.

key key_value

Specifies the query value.

Must be a string of 0 to 512 characters.

map-id map_id

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

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

limit limit

Specifies the maximum number of records to display.

Must be an integer in the range of 1 to 500 characters.

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

Specify the query expression to filter the results of query.

Usage Guidelines

Use this command to display the session details.

cdl show status

Configures the CDL parameters to display the status of the database.

Command Mode

Exec

Syntax

cdl status db-name db_name 

db-name db_name

Specifies the database name for displaying the corresponding status.

Must be a string of 1 to 16 characters.

Usage Guidelines

Use this command to display the status of the queried database.

clear ipam

Clears the IPAM operational data.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec

Syntax

clear ipam 

Usage Guidelines

Use this command to clear the IPAM operational data.

clear subscriber

Clears the subscriber data.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec

Syntax

clear subscriber 

Usage Guidelines

Use this command to clear the subscriber data.

commit

Configures the commit parameters.

Command Mode

Exec

Syntax

commit [ abort { persist-id persist_id } | confirm { persist-id persist_id  } | persist-id persist_id ] 

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.

Usage Guidelines

Use this command to configure the commit parameters.

compare

Compares the running configuration to another configuration or a file.

Command Mode

Exec

Syntax

compare file { filename[.kube | .ssh/] | configuration } 

filename[.kube | .ssh/]

Specify the file name or the directory path of the file to be compared.

Must be a string.

configuration

Specify the desired configuration to be compared against.

Must be a string.

Usage Guidelines

Use this command to compare the files.

config

Manipulates the software configuration information.

Command Mode

Exec

Syntax

config [ exclusive | no-confirm | shared | terminal ] 

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.

Usage Guidelines

Use this command to manipulate the software configuration information.

describe

Displays the command information.

Command Mode

Exec

Syntax

describe command 

command

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

The command must be one of the following:

  • aaa

  • cd

  • cdl

  • commit

  • compare

  • config

  • describe

  • dump

  • exit

  • help

  • history

  • id

  • idle-timeout

  • ignore-leading-space

  • job

  • leaf-prompting

  • license

  • logout

  • monitor

  • no

  • paginate

  • quit

  • rcm

  • screen-length

  • screen-width

  • send

  • show

  • show-defaults

  • smiuser

  • system

  • terminal

  • timestamp

  • who

Usage Guidelines

Use this command to display the command specific information.

dump

Removes the transaction history.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec

Syntax

dump transactionhistory 

Usage Guidelines

Use this command to remove the transaction history.

exit

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

Command Mode

Exec

Syntax

exit 

Usage Guidelines

Use this command to exit the current configuration mode and return to the previous configuration mode. When used in the Exec mode, exits the management session.

help

Displays help information for a specified command.

Command Mode

Exec

Syntax

help command 

command

Specify the command name to display the corresponding help information.

The command must be one of the following:

  • aaa

  • cd

  • cdl

  • commit

  • compare

  • config

  • describe

  • dump

  • exit

  • help

  • history

  • id

  • idle-timeout

  • ignore-leading-space

  • job

  • leaf-prompting

  • license

  • logout

  • monitor

  • no

  • paginate

  • quit

  • rcm

  • screen-length

  • screen-width

  • send

  • show

  • show-defaults

  • smiuser

  • system

  • terminal

  • timestamp

  • who

Usage Guidelines

Use this command to view help information for a specified command.

history

Configures the command history cache size.

Command Mode

Exec

Syntax

history history_size  

history_size

Specify the command history cache size.

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

Usage Guidelines

Use this command to configure the command history cache size.

id

Displays user ID information.

Command Mode

Exec

Syntax

id 

Usage Guidelines

Use this command to view the user ID information.

idle-timeout

Configures the maximum duration a command can remain idle in seconds after which the system automatically terminates the connection.

Command Mode

Exec

Syntax

idle-timeout duration 

duration

Specify the idle timeout duration in seconds.

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

Usage Guidelines

Use this command to configure the maximum duration a command can remain idle.

ignore-leading-space

Configures whether to ignore or consider the leading whitespace at the beginning of a command.

Command Mode

Exec

Syntax

ignore-leading-space { false | true } 

{ false | true }

Specify false to ignore the leading whitespace, and true to consider it.

Must be either "false" or "true".

Usage Guidelines

Use this command to configure whether to ignore or consider leading whitespace at the beginning of a command.

job

Suspends the jobs that are running in the background.

Command Mode

Exec

Syntax

job stop job_id 

job_id

Specify the job ID for suspending the corresponding job.

Must be an integer.

Usage Guidelines

Use this command to suspend the jobs that are running in the background.

leaf-prompting

Enables or disables automatic querying for leaf values.

Command Mode

Exec

Syntax

leaf-prompting { false | true } 

{ false | true }

Specify false to disable leaf prompting, and true to enable.

Must be either "false" or "true".

Usage Guidelines

Use this command to automatically query for leaf values.

license smart deregister

Configures the license parameters for the VNF deregistration.

Command Mode

Exec

Syntax

license smart deregister 

deregister

Specify to deregister the VNF for smart licensing.

Usage Guidelines

Use this command to configure the license parameters for the VNF deregistration.

license smart register

Configures the license parameters for the VNF registration.

Command Mode

Exec

Syntax

license smart register force idtoken token_id 

register

Specify to register the VNF for Smart Licensing.

force

Specify to enable the force registration of the agent.

idtoken token_id

Specify the ID token to register the agent with.

Must be an integer.

Usage Guidelines

Use this command to configure the license parameters for the VNF registration.

license smart renew

Configures the license parameters for the VNF renewal.

Command Mode

Exec

Syntax

license smart renew { ID | auth } 

renew

Renew the smart agent IDs and authentication.

ID

Specify to renew the smart agent license registration information.

auth

Initiate the manual update of the license usage information with Cisco.

Usage Guidelines

Use this command to configure the license parameters for the VNF renewal.

logout

Logout a specific session or a specific user from all sessions.

Command Mode

Exec

Syntax

logout [ session session_id | user user_name ] 

session session_id

Specify the session ID from the possible completion options.

Must be a string.

user user_name

Specify the user name or the user process from the possible completion options.

Must be a string.

Usage Guidelines

Use this command to log out a specific session or a specific user from all sessions.

monitor protocol

Configures the SMF to monitor the protocol.

Command Mode

Exec

Syntax

monitor protocol interface interface_name [ capture-duration duration ] 

interface interface_name

Specify the name of interface on which PCAP is captured.

Must be a string.

capture-duration duration

Specify the duration, in seconds, during which PCAP is captured. The default value is 300 seconds.

Must be an integer.

Usage Guidelines

Use this command to monitor the protocol.

monitor subscriber

Configures the SMF to monitor the subscribers.

Command Mode

Exec

Syntax

monitor subscriber supi supi [ capture-duration duration ] | subscriber-dump filename file_name | subscriber-list 

supi supi

Specify the subscriber identifier.

Must be a string.

capture-duration duration

Specify the duration, in seconds, during which PCAP is captured. The default value is 300 seconds.

Must be an integer.

filename file_name

Specify the path of the file name to be dumped.

Must be a string.

Usage Guidelines

Use this command to monitor the subscribers.

no

Restores the command history cache size to its default setting. See the history command.

Command Mode

Exec

Syntax

no history 

Usage Guidelines

Use this command to configure the command history cache size to its default setting. For more details, see the history command.

paginate

Configures whether or not to paginate CLI command output.

Command Mode

Exec

Syntax

paginate { false | true } 

{ false | true }

Specify false to disable paginating CLI command output, and true to enable.

Must be either "false" or "true".

Usage Guidelines

Use this command to paginate the command output.

quit

Exits the management session.

Command Mode

Exec

Syntax

quit 

Usage Guidelines

Use this command to exit the management session.

rcm switchover

Configures Redundancy and Configuration Manager (RCM) switchover operation.

Command Mode

Exec

Syntax

rcm switchover source ip_address destination ip_address 

source ip_address

Specify the source IP address.

Must be an IP address.

destination ip_address

Specify the destination IP address.

Must be an IP address.

Usage Guidelines

Use this command to configure RCM switchover operation.

screen-length

Configures the number of rows of text that the terminal screen displays.

Command Mode

Exec

Syntax

screen-length number_of_rows 

number_of_rows

Specify the number of rows that the terminal screen displays.

Must be an integer.

Usage Guidelines

Use this command to set the number of rows that the terminal screen displays.

screen-width

Configures the number of columns that the terminal screen displays.

Command Mode

Exec

Syntax

screen-width number_of_columns 

number_of_columns

Specify the number of columns that the terminal screen displays.

Must be an integer.

Usage Guidelines

Use this command to set the number of columns that the terminal screen displays.

send

Sends messages to the terminal of a specific user or all users.

Command Mode

Exec

Syntax

send user message  

user

Specify the user to whom the message must be sent.

Must be a string. Select from the possible completion options.

message

Specify the message that must be sent.

Must be a string.

Usage Guidelines

Use this command to send messages to the terminal of a specific user or to all users.

show

Displays the system information.

Command Mode

Exec

Syntax

show system_component 

system_component

Specify the component to view the information.

Must be a string. Select from the possible completion options.

Usage Guidelines

Use this command to view the system information.

show-defaults

Displays the default configuration.

Command Mode

Exec

Syntax

show-defaults { false | true } 

{ false | true }

Specify whether to display or hide the default values. To display, select true. Otherwise, select false.

Must be either "false" or "true".

Usage Guidelines

Use this command to view the default configuration.

smiuser

Configures the Subscriber Microservices Infrastructure (SMI) user account parameters.

Command Mode

Exec

Syntax

smiuser { add-group groupname group_name | add-user { username username | password password } | change-password { username username | current_password current_password | new_password new_password | confirm_password new_password | password_expire_days expire_days } | change-self-password { current_password current_password | new_password new_password | confirm_password new_password | password_expire_days expire_days } | delete-group groupname group_name | delete-user username username | unassign-user-group { groupname groupname_pam | username username_pam } | update-password-length length password_length } 

username username

Specify the username.

Must be a string.

password password

Specify the user password.

Must be a string.

confirm_password new_password

Confirm the new password.

Must be a string.

current_password current_password

Specify the current password.

Must be a string.

new_password new_password

Specify the new password.

Must be a string.

password_expire_days expire_days

Specify the number of days before the password expires.

Must be an integer.

groupname group_name

Specify the group name.

Must be a string.

groupname groupname_pam

Specify the group name in PAM.

Must be a string.

username username_pam

Specify the user name in PAM.

Must be a string.

length password_length

Specify the minimum password length.

Must be an integer.

Usage Guidelines

Use this command to configure the smiuser parameters.

system

Configures the NF's system operations.

Command Mode

Exec

Syntax

system { ops-center stop | synch { start | stop } | upgrade | uuid-override new-uuid uuid_value } 

ops-center stop

Stop the synching of configuration.

synch { start | stop }

Starts or stops the synching of configuration,

upgrade

Initiates the upgrade of a product.

uuid-override new-uuid uuid_value

Change the Universally Unique Identifier (UUID) to a new value.

Must be a string.

Usage Guidelines

Use this command to display the NF's system operations.

terminal

Configures the type of terminal.

Command Mode

Exec

Syntax

terminal terminal_type 

terminal_type

Specify the terminal type.

Must be one of the following:

  • ansi

  • generic

  • linux

  • vt100

  • xterm

Usage Guidelines

Use this command to configure the terminal type.

timestamp

Configures the timestamp parameters.

Command Mode

Exec

Syntax

timestamp { disable | enable } 

{ disable | enable }

Enable or disable the timestamp display.

Usage Guidelines

Use this command to configure the timestamp.

who

Displays information on currently logged on users.

Command Mode

Exec

Syntax

who  

Usage Guidelines

Use this command to view information on currently logged on users. The command output displays the Session, User, Context, From (IP address), Protocol, Date, and Mode information.