Configuration Command Reference

aaa

Configures AAA based user management parameters.

Privilege Level

Security Administrator, Administrator

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

Specifies the current password of the user.

Must be a string.

new-password user_password

Specifies a new password of the user.

Must be a string.

confirm-password user_password

Enter the new password once again to change the password.

Must be a string.

Usage Guidelines

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

active-charging service

Configures Active Charging Service (ACS) parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

active-charging service service_name 

service service_name

Specify name of the Active Charging Service.

Must be a string of 1-15 characters.

Usage Guidelines

Use this command to configure the ACS parameters.

You can configure a maximum of one element with this command.

active-charging service bandwidth-policy

Configures ACS bandwidth policy parameters.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name )

Syntax

bandwidth-policy bandwidth_policy_name 

bandwidth-policy bandwidth_policy_name

Specify name of the ACS Bandwidth Policy.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to configure ACS bandwidth policy parameters. The CLI prompt changes to the Bandwidth Policy Configuration mode (config-bandwidth-policy-<policy_name>).

You can configure a maximum of 64 elements with this command.

active-charging service bandwidth-policy flow limit-for-bandwidth id

Configures bandwidth ID and bandwidth policy group parameters.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Bandwidth Policy Configuration (config-bandwidth-policy-policy_name )

Syntax

flow limit-for-bandwidth id id group-id group_id 

group-id group_id

Specify the bandwidth policy group ID.

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

id id

Specify the bandwidth ID.

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

Usage Guidelines

Use this command to configure the bandwidth ID and bandwidth policy group parameters.

You can configure a maximum of 1000 elements with this command.

active-charging service bandwidth-policy group-id

Configures bandwidth policy group ID.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Bandwidth Policy Configuration (config-bandwidth-policy-policy_name )

Syntax

group-id group_id 

group-id group_id

Specify the bandwidth policy group ID.

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

Usage Guidelines

Use this command to configure the bandwidth policy group ID.

You can configure a maximum of 1000 elements with this command.

active-charging service bandwidth-policy group-id direction downlink grpPeakBwp

Configures peak bandwidth parameters.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Bandwidth Policy Configuration (config-bandwidth-policy-policy_name )

Syntax

group-id group_id direction downlink peak-data-rate-kbps peak_data_rate peak-burst-size peak_burst_size violate-action lower-ip-precedence committed-data-rate-kbps 

Syntax

group-id group_id direction uplink peak-data-rate-kbps peak_data_rate peak-burst-size peak_burst_size violate-action lower-ip-precedence committed-data-rate-kbps 

committed-burst-size committed_burst_size

Specify the committed burst size in bytes.

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

committed-options committed_option

Specify the committed option.

Must be one of the following:

  • committed-data-rate-kbps : Specify Committed Data Rate in kilo bits per second. This can also be used to specify GBR for Bearer Binding (without the exceed-action).

  • committed-data-rate : Specify Committed Data Rate in bits per second. This can also be used to specify GBR for flow Binding (without the exceed-action).

committed-value committed_value

Specify the bandwidth in bits per second.

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

exceed-action exceed_action

Specify the action to be taken if committed data rate is surpassed.

Must be one of the following:

  • discard : Specify to discard the packet.

  • lower-ip-precedence : Specify to lower the IP precedence of the packet.

peak-burst-size peak_burst_size

Specify the burst size in bytes.

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

peak-options peak_options

Specify the peak data rate option.

Must be one of the following:

  • peak-data-rate-kbps : Specify Peak Data Rate in kilo bits per second.

  • peak-data-rate : Specify Peak Data Rate in bits per second.

peak-value peak_value

Specify the bandwidth in bits per second.

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

violate-action violate_action

Specify the action to be taken if Peak Data Rate is surpassed.

Must be one of the following:

  • discard : Specify to discard the packet.

  • lower-ip-precedence : Specify to lower the IP precedence of the packet.

Usage Guidelines

Configures bandwidth control in downlink or uplink directions. Use this command to configure the peak bandwidth parameters.

active-charging service bandwidth-policy group-id direction uplink grpPeakBwp

Configures peak bandwidth parameters.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Bandwidth Policy Configuration (config-bandwidth-policy-policy_name )

Syntax

group-id group_id direction downlink peak-data-rate-kbps peak_data_rate peak-burst-size peak_burst_size violate-action lower-ip-precedence committed-data-rate-kbps 

Syntax

group-id group_id direction uplink peak-data-rate-kbps peak_data_rate peak-burst-size peak_burst_size violate-action lower-ip-precedence committed-data-rate-kbps 

committed-burst-size committed_burst_size

Specify the committed burst size in bytes.

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

committed-options committed_option

Specify the committed option.

Must be one of the following:

  • committed-data-rate-kbps : Specify Committed Data Rate in kilo bits per second. This can also be used to specify GBR for Bearer Binding (without the exceed-action).

  • committed-data-rate : Specify Committed Data Rate in bits per second. This can also be used to specify GBR for flow Binding (without the exceed-action).

committed-value committed_value

Specify the bandwidth in bits per second.

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

exceed-action exceed_action

Specify the action to be taken if committed data rate is surpassed.

Must be one of the following:

  • discard : Specify to discard the packet.

  • lower-ip-precedence : Specify to lower the IP precedence of the packet.

peak-burst-size peak_burst_size

Specify the burst size in bytes.

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

peak-options peak_options

Specify the peak data rate option.

Must be one of the following:

  • peak-data-rate-kbps : Specify Peak Data Rate in kilo bits per second.

  • peak-data-rate : Specify Peak Data Rate in bits per second.

peak-value peak_value

Specify the bandwidth in bits per second.

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

violate-action violate_action

Specify the action to be taken if Peak Data Rate is surpassed.

Must be one of the following:

  • discard : Specify to discard the packet.

  • lower-ip-precedence : Specify to lower the IP precedence of the packet.

Usage Guidelines

Configures bandwidth control in downlink or uplink directions. Use this command to configure the peak bandwidth parameters.

active-charging service buffering-limit

Configures flow/session-based packet buffering.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name )

Syntax

buffering-limit { [ flow-max-packets flow_max_packets ] [ subscriber-max-packets subscriber_max_packets ] } 

flow-max-packets flow_max_packets

Specify the maximum number of packets to be buffered per flow.

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

subscriber-max-packets subscriber_max_packets

Specify the maximum number of packets to be buffered per subscriber.

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

Usage Guidelines

Use this command to configure flow/session-based packet buffering configuration.

active-charging service charging-action

Configures ACS charging actions.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name )

Syntax

charging-action charging_action_name [ [ content-id content_id ] [ nexthop-forwarding-address { ipv4_address | ipv6_address } [ qos-class-identifier qos_class_id ] [ service-identifier service_id ] [ ft-notify-ue ] ] 

charging-action charging_action_name

Specify name of the charging action.

Must be a string of 1-63 characters.

content-id content_id

Specify the content ID to use in the generated billing records, as well as the AVP used by the Credit Control Application, such as the "Rating-Group" AVP for use by the Diameter Credit Control Application (DCCA). This identifier assists the carrier's billing post processing and is also used by the credit-control system to use independent quotas for different value of content-id.

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

nexthop-forwarding-address { ipv4_address | ipv6_address }

Specify the nexthop forwarding address for this charging action. When an uplink packet matches a rule and a charging action is applied to it this nexthop forwarding address is used.

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

-Or-

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

qos-class-identifier qos_class_id

Specify the QoS Class Identifier (QCI).

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

service-identifier service_id

Specify the service identifier to use in the generated billing records, as well as the AVP used by the Credit Control Application, such as the "Service-Identifier" AVP for use by DCCA. This is a more general classifier than content-id.

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

tft-notify-ue

Specify whether or not TFT updates are sent to UE. Use this command to suppress the selected TFT updates from being sent to the UE. This helps to identify if the appropriate TFT defined in the charging action needs to be sent to the UE or not.

Usage Guidelines

Use this command to create and configure an ACS charging action. A charging action represents actions to be taken when a configured rule is matched. Actions could range from generating an accounting record (for example, an EDR) to dropping the IP packet, etc. The charging action will also determine the metering principle whether to count retransmitted packets and which protocol field to use for billing (L3/L4/L7 etc).

Example

The following command creates a charging action named action123 and changes to the ACS Charging Action Configuration Mode:
charging-action action123 

active-charging service charging-action allocation-retention-priority

Configures the Allocation Retention Priority (ARP).

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

allocation-retention-priority priority_level { pci preemption_capability_indicator | pvi preemption_vulnerability_indicator } 

allocation-retention-priority priority_level

Specify the priority.

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

pci preemption_capability_indicator

Specify the Pre-emption Capability Indicator (PCI).

Must be one of the following:

  • MAY_PREEMPT

  • NOT_PREEMPT

pvi preemption_vulnerability_indicator

Specify the Pre-emption Vulnerability Indicator (PVI).

Must be one of the following:

  • NOT_PREEMPTABLE

  • PREEMPTABLE

Usage Guidelines

This command configures the ARP, which indicates the priority of allocation and retention of the service data flow. The ARP resolves conflicts in demand for network resources. At the time of resource crunch, this parameter prioritizes allocation of resources during bearer establishment and modification. In a congestion situation, a lower ARP flow may be dropped to free up capacity. Once a service flow is successfully established, this parameter plays no role in quality of service (QoS) experienced by the flow.

Example

The following command sets the ARP to 10:
allocation-retention-priority 10 

active-charging service charging-action billing-action

Configures the billing action for packets that match specific ruledefs.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

billing-action egcdr 

egcdr

Specify to enable eG-CDR billing.

Usage Guidelines

Use this command to enable eG-CDR type of billing for content matching this charging action.

active-charging service charging-action cca charging credit

Configures the Credit Control Charging Credit behavior.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

cca charging credit [ rating-group coupon_id ] [ preemptively-request ] 

preemptively-request

Specify preemptively requested charging credit behavior.

rating-group coupon_id

Specify the coupon ID used in prepaid charging as rating-group which maps to the coupon ID for prepaid customer. This option also assigns different content-types for the same charging action depending upon whether or not prepaid is enabled. This rating-group overrides the content ID, if present in the same charging-action for the prepaid customer in Diameter Credit Control Application (DCCA). But, only the content IDs will be used in eG-CDRs irrespective of the presence of rating-group in that charging action.

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

Usage Guidelines

Use this command to configure RADIUS/Diameter Prepaid Credit Control Charging Credit behavior.

active-charging service charging-action flow action

Configures to take the redirect-url or terminate-flow action on packets that match ruledefs.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

flow action { redirect-url redirect_url | terminate-flow } 

redirect-url redirect_url

Specify to redirect URL.

Must be a string.

terminate-flow

Specify to terminate flow.

Usage Guidelines

Use this command to specify the action to take on packets, for example to terminate.

Example

The following command sets the flow action to terminate:
flow action terminate-flow 

active-charging service charging-action flow action discard

Configures discard action on packets that match ruledefs.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

flow action discard [ downlink | uplink ] 

downlink

Specify only downlink packets.

uplink

Specify only uplink packets.

Usage Guidelines

Use this command to configure discard action on packets that match ruledefs.

active-charging service charging-action flow action readdress

Configures the readdress server for this charging action.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

flow action readdress server { ipv4_address | ipv6_address } 

server { ipv4_address | ipv6_address }

Specify IP address of the readdress server.

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

-Or-

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

Usage Guidelines

Use this command to configure the readdress server for this charging action.

active-charging service charging-action flow limit-for-bandwidth

For Session Control functionality, this command allows you to enable or disable bandwidth limiting.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

flow limit-for-bandwidth { direction | id bw_limit_id } 

id bw_limit_id

Specify the bandwidth limiting ID.

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

Usage Guidelines

Use this command to limit the bandwidth a subscriber uses in the uplink and downlink directions under Session Control.

active-charging service charging-action flow limit-for-bandwidth direction downlink peak-data-rate

Configures the peak data rate in bits per second.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

flow limit-for-bandwidth direction downlink peak-data-rate peak_data_rate peak-burst-size peak_burst_size violate-action violate_action [ committed-data-rate committed_data_rate committed-burst-size committed_burst_size exceed-action exceed_action ] 

Syntax

flow limit-for-bandwidth direction uplink peak-data-rate peak_data_rate peak-burst-size peak_burst_size violate-action violate_action [ committed-data-rate committed_data_rate committed-burst-size committed_burst_size exceed-action exceed_action ] 

committed-burst-size committed_burst_size

Specify the committed burst size in bytes.

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

Default Value: 3000.

committed-data-rate committed_data_rate

Specify the Committed Data Rate in bits per second. This can also be used to specify GBR for Bearer Binding (without the exceed-action).

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

Default Value: 144000.

exceed-action exceed_action

Specify the action to be taken if the Committed Data Rate is surpassed.

Must be one of the following:

  • discard : Specify to discard the packet.

  • lower-ip-precedence : Specify to lower the IP precedence of the packet.

peak-burst-size peak_burst_size

Specify the peak burst size in bytes.

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

violate-action violate_action

Specify the action to be taken if the Peak Data Rate is surpassed.

Must be one of the following:

  • discard : Specify to discard the packet.

  • lower-ip-precedence : Specify to lower the IP precedence of the packet.

peak_data_rate

Specify the peak data rate in bits per second.

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

Usage Guidelines

Configures bandwidth control in downlink or uplink directions. Use this command to configure the peak data rate in bits per second.

active-charging service charging-action flow limit-for-bandwidth direction uplink peak-data-rate

Configures the peak data rate in bits per second.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

flow limit-for-bandwidth direction downlink peak-data-rate peak_data_rate peak-burst-size peak_burst_size violate-action violate_action [ committed-data-rate committed_data_rate committed-burst-size committed_burst_size exceed-action exceed_action ] 

Syntax

flow limit-for-bandwidth direction uplink peak-data-rate peak_data_rate peak-burst-size peak_burst_size violate-action violate_action [ committed-data-rate committed_data_rate committed-burst-size committed_burst_size exceed-action exceed_action ] 

committed-burst-size committed_burst_size

Specify the committed burst size in bytes.

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

Default Value: 3000.

committed-data-rate committed_data_rate

Specify the Committed Data Rate in bits per second. This can also be used to specify GBR for Bearer Binding (without the exceed-action).

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

Default Value: 144000.

exceed-action exceed_action

Specify the action to be taken if the Committed Data Rate is surpassed.

Must be one of the following:

  • discard : Specify to discard the packet.

  • lower-ip-precedence : Specify to lower the IP precedence of the packet.

peak-burst-size peak_burst_size

Specify the peak burst size in bytes.

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

violate-action violate_action

Specify the action to be taken if the Peak Data Rate is surpassed.

Must be one of the following:

  • discard : Specify to discard the packet.

  • lower-ip-precedence : Specify to lower the IP precedence of the packet.

peak_data_rate

Specify the peak data rate in bits per second.

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

Usage Guidelines

Configures bandwidth control in downlink or uplink directions. Use this command to configure the peak data rate in bits per second.

active-charging service charging-action tft packet-filter

Configures the packet filter to use in Traffic Flow Template (TFT) sent to the MS.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

tft packet-filter packet_filter_name 

packet-filter packet_filter_name

Specify name of the packet filter.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to configure the packet filter to be sent to the MS. Up to eight packet filters can be specified in a charging action.

You can configure a maximum of eight elements with this command.

Example

The following command configures the packet filter filter23 to be sent to the MS:
tft packet-filter filter23 

active-charging service charging-action tos af11

Configures using Assured Forwarding 11 Per Hop Behavior (PHB).

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

tos af11 [ downlink | uplink ] 

downlink

Specify only downlink packets.

uplink

Specify only uplink packets.

Usage Guidelines

Use this command to configure using Assured Forwarding 11 Per Hop Behavior (PHB).

active-charging service charging-action tos af12

Configures using Assured Forwarding 12 Per Hop Behavior (PHB).

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

tos af12 [ downlink | uplink ] 

downlink

Specify only downlink packets.

uplink

Specify only uplink packets.

Usage Guidelines

Use this command to configure using Assured Forwarding 12 Per Hop Behavior (PHB).

active-charging service charging-action tos af13

Configures using Assured Forwarding 13 Per Hop Behavior (PHB).

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

tos af13 [ downlink | uplink ] 

downlink

Specify only downlink packets.

uplink

Specify only uplink packets.

Usage Guidelines

Use this command to configure using Assured Forwarding 13 Per Hop Behavior (PHB).

active-charging service charging-action tos af21

Configures using Assured Forwarding 21 Per Hop Behavior (PHB).

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

tos af21 [ downlink | uplink ] 

downlink

Specify only downlink packets.

uplink

Specify only uplink packets.

Usage Guidelines

Use this command to configure using Assured Forwarding 21 Per Hop Behavior (PHB).

active-charging service charging-action tos af22

Configures using Assured Forwarding 22 Per Hop Behavior (PHB).

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

tos af22 [ downlink | uplink ] 

downlink

Specify only downlink packets.

uplink

Specify only uplink packets.

Usage Guidelines

Use this command to configure using Assured Forwarding 22 Per Hop Behavior (PHB).

active-charging service charging-action tos af23

Configures using Assured Forwarding 23 Per Hop Behavior (PHB).

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

tos af23 [ downlink | uplink ] 

downlink

Specify only downlink packets.

uplink

Specify only uplink packets.

Usage Guidelines

Use this command to configure using Assured Forwarding 23 Per Hop Behavior (PHB).

active-charging service charging-action tos af31

Configures using Assured Forwarding 31 Per Hop Behavior (PHB).

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

tos af31 [ downlink | uplink ] 

downlink

Specify only downlink packets.

uplink

Specify only uplink packets.

Usage Guidelines

Use this command to configure using Assured Forwarding 31 Per Hop Behavior (PHB).

active-charging service charging-action tos af32

Configures using Assured Forwarding 32 Per Hop Behavior (PHB).

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

tos af32 [ downlink | uplink ] 

downlink

Specify only downlink packets.

uplink

Specify only uplink packets.

Usage Guidelines

Use this command to configure using Assured Forwarding 32 Per Hop Behavior (PHB).

active-charging service charging-action tos af33

Configures using Assured Forwarding 33 Per Hop Behavior (PHB).

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

tos af33 [ downlink | uplink ] 

downlink

Specify only downlink packets.

uplink

Specify only uplink packets.

Usage Guidelines

Use this command to configure using Assured Forwarding 33 Per Hop Behavior (PHB).

active-charging service charging-action tos af41

Configures using Assured Forwarding 41 Per Hop Behavior (PHB).

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

tos af41 [ downlink | uplink ] 

downlink

Specify only downlink packets.

uplink

Specify only uplink packets.

Usage Guidelines

Use this command to configure using Assured Forwarding 41 Per Hop Behavior (PHB).

active-charging service charging-action tos af42

Configures using Assured Forwarding 42 Per Hop Behavior (PHB).

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

tos af42 [ downlink | uplink ] 

downlink

Specify only downlink packets.

uplink

Specify only uplink packets.

Usage Guidelines

Use this command to configure using Assured Forwarding 42 Per Hop Behavior (PHB).

active-charging service charging-action tos af43

Configures using Assured Forwarding 43 Per Hop Behavior (PHB).

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

tos af43 [ downlink | uplink ] 

downlink

Specify only downlink packets.

uplink

Specify only uplink packets.

Usage Guidelines

Use this command to configure using Assured Forwarding 43 Per Hop Behavior (PHB).

active-charging service charging-action tos be

Configures using Best Effort Forwarding PHB.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

tos be [ downlink | uplink ] 

downlink

Specify only downlink packets.

uplink

Specify only uplink packets.

Usage Guidelines

Use this command to configure using Best Effort Forwarding Per Hop Behavior (PHB).

active-charging service charging-action tos ef

Configures using Expedited Forwarding PHB.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

tos ef [ downlink | uplink ] 

downlink

Specify only downlink packets.

uplink

Specify only uplink packets.

Usage Guidelines

Use this command to configure using Expedited Forwarding Per Hop Behavior (PHB).

active-charging service charging-action tos lower-bits

Configures the least-significant six bits in the ToS byte with the specified numeric value.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Charging Action Configuration (config-charging-action-charging_action_name )

Syntax

tos lower-bits value [ downlink | uplink ] 

downlink

Specify the ToS only for downlink packets.

lower-bits value

Specify the value.

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

uplink

Specify the ToS only for uplink packets.

Usage Guidelines

Use this command to configure the least-significant six bits in the ToS byte with the specified numeric value.

active-charging service content-filtering category policy-id

Configures Content Filtering Category Policy ID.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name )

Syntax

content-filtering category policy-id cf_category_policy_id 

policy-id cf_category_policy_id

Specify the Content Filtering Category Policy ID.

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

Usage Guidelines

Use this command to configure the Content Filtering Category Policy ID. The CLI prompt changes to the Content Filtering Category Policy Configuration mode (config-policy-id-<content_filtering_policy_id>).

active-charging service content-filtering category policy-id analyze priority

Assigns priority to a Content Filtering Category in the Content Filtering Policy.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Content Filtering Category Policy Configuration (config-policy-id-content_filtering_policy_id )

Syntax

analyze priority cf_category_priority 

priority cf_category_priority

Specify priority of the Content Filtering Category in the Content Filtering Policy.

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

Usage Guidelines

Use this command to assign priority to a Content Filtering Category in a Content Filtering Policy.

active-charging service content-filtering category policy-id analyze priority all

Configures all content to be rated.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Content Filtering Category Policy Configuration (config-policy-id-content_filtering_policy_id )

Syntax

analyze priority cf_category_priority all action { allow | content-insert content_to_insert } 

action

Specify an action.

allow

Specify the allow action.

content-insert content_to_insert

Specify the content insert action, and the content string to insert.

Must be a string.

Usage Guidelines

Use this command to configure the all content to be rated.

active-charging service content-filtering category policy-id analyze priority category

Configures category of the content to be rated.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Content Filtering Category Policy Configuration (config-policy-id-content_filtering_policy_id )

Syntax

analyze priority cf_category_priority category category_name action { allow | content-insert content_to_insert } 

action

Specify an action.

allow

Specify the allow action.

category category_name

Specify name of the category.

Must be one of the following:

  • ABOR

  • ADULT

  • ADVERT

  • ANON

  • ART

  • AUTO

  • BACKUP

  • BLACK

  • BLOG

  • BUSI

  • CAR

  • CDN

  • CHAT

  • CMC

  • CRIME

  • CULT

  • DRUG

  • DYNAM

  • EDU

  • ENERGY

  • ENT

  • FIN

  • FORUM

  • GAMB

  • GAME

  • GLAM

  • GOVERN

  • HACK

  • HATE

  • HEALTH

  • HOBBY

  • HOSTS

  • KIDS

  • LEGAL

  • LIFES

  • MAIL

  • MIL

  • NEWS

  • OCCULT

  • PEER

  • PERS

  • PHOTO

  • PLAG

  • POLTIC

  • PORN

  • PORTAL

  • PROXY

  • REF

  • REL

  • SCI

  • SEARCH

  • SHOP

  • SPORT

  • STREAM

  • SUIC

  • SXED

  • TECH

  • TRAVE

  • UNKNOW

  • VIOL

  • VOIP

  • WEAP

  • WHITE

content-insert content_to_insert

Specify the content insert action, and the content string to insert.

Must be a string.

Usage Guidelines

Use this command to configure the category of the content to be rated.

active-charging service content-filtering category policy-id analyze priority x-category

Configures unclassified categories to be rated.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Content Filtering Category Policy Configuration (config-policy-id-content_filtering_policy_id )

Syntax

analyze priority cf_category_priority x-category xcategory_name action { allow | content-insert content_to_insert } 

action

Specify an action.

allow

Specify the allow action.

content-insert content_to_insert

Specify the content insert action, and the content string to insert.

Must be a string.

x-category xcategory_name

Specify name of the x-category.

Must be a string of 1-6 characters.

Usage Guidelines

Use this command to configure unclassified categories to be rated.

active-charging service credit-control group

Configures prepaid services for Diameter/RADIUS applications.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name )

Syntax

credit-control group cc_group_name 

group cc_group_name

Specify name of the credit control group.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to enable/disable Prepaid Credit Control Configuration for RADIUS/Diameter charging mode, and specify the credit control group.

active-charging service credit-control group associate

Associates the failure handling template.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Group Configuration (config-group-credit_control_group_name )

Syntax

associate failure-handling-template template_name 

failure-handling-template template_name

Specify name of the failure handling template.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to associate the failure handling template.

active-charging service credit-control group diameter

Configures accepting/ignoring service ID in the Service-Identifier AVP defined in the Diameter dictionaries.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Group Configuration (config-group-credit_control_group_name )

Syntax

diameter ignore-service-id { false | true } 

ignore-service-id { false | true }

Specify to enable or disable usage of service ID. To disable, set to true.

Must be one of the following:

  • false

  • true

Default Value: false.

Usage Guidelines

Use this command to ignore/accept service ID value in the Service-Identifier AVP in the Diameter dictionaries.

Example

The following command specifies to ignore service ID in the Diameter dictionaries:
diameter ignore-service-id 

active-charging service credit-control group diameter origin

Configures the Diameter Credit Control Origin Endpoint parameter.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Group Configuration (config-group-credit_control_group_name )

Syntax

diameter origin endpoint origin_endpoint_name 

origin endpoint origin_endpoint_name

Specify name of the Diameter Credit Control Origin Endpoint.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to configure the Diameter Credit Control Origin Endpoint parameter.

active-charging service credit-control group diameter service-context-id

Configures the value to be sent in the Service-Context-Id AVP, which defines the context in which DCCA is used.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Group Configuration (config-group-credit_control_group_name )

Syntax

diameter service-context-id service_context_id 

service-context-id service_context_id

Specify the value to be sent in the Service-Context-Id AVP.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to specify the value to be sent in the Service-Context-Id AVP, which defines the context in which DCCA is used.

active-charging service credit-control group diameter session

Configures Diameter Credit Control Session Failover configuration.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Group Configuration (config-group-credit_control_group_name )

Syntax

diameter session failover 

failover

Specify Diameter Credit Control Session Failover.

Usage Guidelines

Use this command to configure Diameter Credit Control Session Failover.

active-charging service credit-control group failure-handling initial-request continue

Configures Diameter Credit Control Failure Handling action to continue.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Group Configuration (config-group-credit_control_group_name )

Syntax

failure-handling initial-request continue continue_action 

Syntax

failure-handling terminate-request continue continue_action 

Syntax

failure-handling update-request continue continue_action 

continue continue_action

Specify the continue action.

Must be one of the following:

  • go-offline-after-tx-expiry : After Tx expiry, start offline charging.

  • retry-after-tx-expiry : After Tx expiry, retry.

Usage Guidelines

Use this command to configure Diameter Credit Control Failure Handling action for CCR-Initial/CCR-Terminate/CR-Update to continue.

active-charging service credit-control group failure-handling initial-request retry-and-terminate

Configures Diameter Credit Control Failure Handling action to retry, and in case of failure, to terminate.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Group Configuration (config-group-credit_control_group_name )

Syntax

failure-handling initial-request retry-and-terminate retry_and_terminate_action 

Syntax

failure-handling terminate-request retry-and-terminate retry_and_terminate_action 

Syntax

failure-handling update-request retry-and-terminate retry_and_terminate_action 

retry-and-terminate retry_and_terminate_action

Specify the retry-and-terminate action.

Must be one of the following:

  • retry-after-tx-expiry : After Tx expiry, retry.

Usage Guidelines

Configures Diameter Credit Control Failure Handling action for CCR-Initial/CCR-Terminate/CR-Update to retry, and in case of failure, to terminate.

active-charging service credit-control group failure-handling initial-request terminate

Configures Diameter Credit Control Failure Handling action as terminate.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Group Configuration (config-group-credit_control_group_name )

Syntax

failure-handling initial-request terminate 

Syntax

failure-handling terminate-request terminate 

Syntax

failure-handling update-request terminate 

Usage Guidelines

Configures Diameter Credit Control Failure Handling action for CCR-Initial/CCR-Terminate/CR-Update to terminate.

active-charging service credit-control group failure-handling terminate-request continue

Configures Diameter Credit Control Failure Handling action to continue.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Group Configuration (config-group-credit_control_group_name )

Syntax

failure-handling initial-request continue continue_action 

Syntax

failure-handling terminate-request continue continue_action 

Syntax

failure-handling update-request continue continue_action 

continue continue_action

Specify the continue action.

Must be one of the following:

  • go-offline-after-tx-expiry : After Tx expiry, start offline charging.

  • retry-after-tx-expiry : After Tx expiry, retry.

Usage Guidelines

Use this command to configure Diameter Credit Control Failure Handling action for CCR-Initial/CCR-Terminate/CR-Update to continue.

active-charging service credit-control group failure-handling terminate-request retry-and-terminate

Configures Diameter Credit Control Failure Handling action to retry, and in case of failure, to terminate.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Group Configuration (config-group-credit_control_group_name )

Syntax

failure-handling initial-request retry-and-terminate retry_and_terminate_action 

Syntax

failure-handling terminate-request retry-and-terminate retry_and_terminate_action 

Syntax

failure-handling update-request retry-and-terminate retry_and_terminate_action 

retry-and-terminate retry_and_terminate_action

Specify the retry-and-terminate action.

Must be one of the following:

  • retry-after-tx-expiry : After Tx expiry, retry.

Usage Guidelines

Configures Diameter Credit Control Failure Handling action for CCR-Initial/CCR-Terminate/CR-Update to retry, and in case of failure, to terminate.

active-charging service credit-control group failure-handling terminate-request terminate

Configures Diameter Credit Control Failure Handling action as terminate.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Group Configuration (config-group-credit_control_group_name )

Syntax

failure-handling initial-request terminate 

Syntax

failure-handling terminate-request terminate 

Syntax

failure-handling update-request terminate 

Usage Guidelines

Configures Diameter Credit Control Failure Handling action for CCR-Initial/CCR-Terminate/CR-Update to terminate.

active-charging service credit-control group failure-handling update-request continue

Configures Diameter Credit Control Failure Handling action to continue.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Group Configuration (config-group-credit_control_group_name )

Syntax

failure-handling initial-request continue continue_action 

Syntax

failure-handling terminate-request continue continue_action 

Syntax

failure-handling update-request continue continue_action 

continue continue_action

Specify the continue action.

Must be one of the following:

  • go-offline-after-tx-expiry : After Tx expiry, start offline charging.

  • retry-after-tx-expiry : After Tx expiry, retry.

Usage Guidelines

Use this command to configure Diameter Credit Control Failure Handling action for CCR-Initial/CCR-Terminate/CR-Update to continue.

active-charging service credit-control group failure-handling update-request retry-and-terminate

Configures Diameter Credit Control Failure Handling action to retry, and in case of failure, to terminate.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Group Configuration (config-group-credit_control_group_name )

Syntax

failure-handling initial-request retry-and-terminate retry_and_terminate_action 

Syntax

failure-handling terminate-request retry-and-terminate retry_and_terminate_action 

Syntax

failure-handling update-request retry-and-terminate retry_and_terminate_action 

retry-and-terminate retry_and_terminate_action

Specify the retry-and-terminate action.

Must be one of the following:

  • retry-after-tx-expiry : After Tx expiry, retry.

Usage Guidelines

Configures Diameter Credit Control Failure Handling action for CCR-Initial/CCR-Terminate/CR-Update to retry, and in case of failure, to terminate.

active-charging service credit-control group failure-handling update-request terminate

Configures Diameter Credit Control Failure Handling action as terminate.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Group Configuration (config-group-credit_control_group_name )

Syntax

failure-handling initial-request terminate 

Syntax

failure-handling terminate-request terminate 

Syntax

failure-handling update-request terminate 

Usage Guidelines

Configures Diameter Credit Control Failure Handling action for CCR-Initial/CCR-Terminate/CR-Update to terminate.

active-charging service credit-control group pending-traffic-treatment forced-reauth

Configures the Diameter Credit Control pending traffic treatment to forced reauthorization.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Group Configuration (config-group-credit_control_group_name )

Syntax

pending-traffic-treatment forced-reauth { drop | pass } 

drop

Specify to drop.

pass

Specify to pass.

Usage Guidelines

Use this command to configure the Diameter Credit Control pending traffic treatment to forced reauthorization.

active-charging service credit-control group pending-traffic-treatment noquota

Configures the Diameter Credit Control Pending Traffic Treatment.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Group Configuration (config-group-credit_control_group_name )

Syntax

pending-traffic-treatment noquota { buffer | drop | pass } 

buffer

Specify to tentatively count/time traffic, and then buffer traffic pending arrival of quota. Buffered traffic will be forwarded and fully charged against the quota when the quota is eventually obtained and the traffic is passed.

drop

Specify to drop any traffic when there is no quota present.

pass

Specify to pass all traffic more or less regardless of quota state.

Usage Guidelines

Controls the pass/drop treatment of traffic while waiting for definitive credit information from the server. Use this command to configure the Credit Control pending traffic treatment.

active-charging service credit-control group pending-traffic-treatment noquota limited-pass

Enables limited access for subscribers when the OCS is unreachable.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Group Configuration (config-group-credit_control_group_name )

Syntax

pending-traffic-treatment noquota limited-pass volume volume 

volume volume

Specify limited volume access to subscriber in case OCS is unreachable.

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

Usage Guidelines

Use this command to enable limited access for subscribers when the OCS is unreachable.

active-charging service credit-control group pending-traffic-treatment quota-exhausted

Configures the Diameter Credit Control Pending Traffic Treatment parameter for quota exhaustion.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Group Configuration (config-group-credit_control_group_name )

Syntax

pending-traffic-treatment quota-exhausted { buffer | drop | pass } 

buffer

Specify to tentatively count/time traffic, and then buffer traffic pending arrival of quota. Buffered traffic will be forwarded and fully charged against the quota when the quota is eventually obtained and the traffic is passed.

drop

Specify to drops any traffic when there is no quota present.

pass

Specify to pass all traffic more or less regardless of quota state.

Usage Guidelines

Use this command to configure the Diameter Credit Control Pending Traffic Treatment for quota exhaustion.

active-charging service credit-control group pending-traffic-treatment trigger

Configures the Diameter Credit Control pending traffic treatment to trigger.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Group Configuration (config-group-credit_control_group_name )

Syntax

pending-traffic-treatment trigger { drop | pass } 

drop

Specify to drop.

pass

Specify to pass.

Usage Guidelines

Use this command to configure the Diameter Credit Control pending traffic treatment to trigger.

active-charging service credit-control group pending-traffic-treatment validity-expired

Configures the Diameter Credit Control pending traffic treatment to validity-expired.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Group Configuration (config-group-credit_control_group_name )

Syntax

pending-traffic-treatment validity-expired { drop | pass } 

drop

Specify to drop.

pass

Specify to pass.

Usage Guidelines

Use this command to configure the Diameter Credit Control pending traffic treatment to validity-expired.

active-charging service credit-control group quota holding-time

Configures the Credit Control Quota Holding Time (QHT).

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Configuration (config-group-credit_control_group_name )

Syntax

quota holding-time holding_time 

holding-time holding_time

Specify the quota holding time in seconds.

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

Usage Guidelines

This command configures the time-based quotas in the prepaid credit control service. Use this command to configure the Credit Control Quota Holding Time.

active-charging service credit-control group quota request-trigger

Configures Credit Control include/exclude packet causing threshold.

Syntax

quota request-trigger { exclude-packet-causing-trigger | include-packet-causing-trigger } 

exclude-packet-causing-trigger

Specify to exclude packet causing trigger.

include-packet-causing-trigger

Specify to include packet causing trigger.

Usage Guidelines

This command sets the time-based quotas in the prepaid credit control service. Use this command to configure the Credit Control include/exclude packet causing threshold.

active-charging service credit-control group timestamp-rounding

Configures the timestamp rounding mechanism for quota consumption.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Group Configuration (config-group-credit_control_group_name )

Syntax

timestamp-rounding timestamp_rounding_mechanism 

timestamp-rounding timestamp_rounding_mechanism

Specify the timestamp rounding mechanism for quota consumption.

Must be one of the following:

  • ceiling : Specify to round off to the smallest integer greater than the fraction.

  • floor : Specify to always discard the fraction.

  • roundoff : If the fractional part is greater than or equal to 0.5, specify to round off to the smallest integer greater than the fraction.

Usage Guidelines

Use this command to configure the timestamp rounding mechanism for quota consumption.

active-charging service credit-control group usage-reporting quotas-to-report based-on-grant

Configures the ACS Credit Control usage reporting type.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Credit Control Group Configuration (config-group-credit_control_group_name )

Syntax

usage-reporting quotas-to-report based-on-grant [ report-only-granted-volume ] 

report-only-granted-volume

Suppresses the input and output octets. If the Granted-Service-Unit (GSU) AVP comes with CC-Total-Octets, then the device will send total, input and output octets in Used-Service-Unit (USU) AVP. If it comes with Total-Octets, the device will send only Total-Octets in USU.

Usage Guidelines

Use this command to configure reporting usage only for granted quota. On issuing this command, the Used-Service-Unit AVP will report quotas based on grant i.e, only the quotas present in the Granted-Service-Unit AVP. With this command only the units for which the quota was granted by the DCCA server will be reported irrespective of the reporting reason.

active-charging service group-of-ruledefs

Configures ACS group-of-ruledefs parameters.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Group of Ruledefs Configuration (config-group-of-ruledefs-group_name )

Syntax

group-of-ruledefs group_of_ruledefs_name 

group-of-ruledefs group_of_ruledefs_name

Specify name of the group-of-ruledefs.

Must be a string.

Usage Guidelines

Use this command to create/configure a group-of-ruledefs. A group-of-ruledefs is a collection of ruledefs to use in access policy creation. Maximum of 384 group-of-ruledefs can be created.

You can configure a maximum of 384 elements with this command.

Example

The following command creates a group-of-ruledefs named group1:
group-of-ruledefs group1 

active-charging service group-of-ruledefs add-ruledef priority

Configures the priority of the ruledef in the current group-of-ruledefs.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Group of Ruledefs Configuration (config-group-of-ruledefs-group_name )

Syntax

add-ruledef priority ruledef_priority ruledef ruledef_name 

priority ruledef_priority

Specify the priority of the ruledef. The priority must be unique within the group-of-ruledefs.

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

ruledef ruledef_name

Specify name of the ruledef to add to the current group-of-ruledefs.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to add ruledefs to a group-of-ruledefs, and configure the priority of the ruledef in the current group-of-ruledefs. A maximum of 512 ruledefs can be added to a group of ruledefs.

You can configure a maximum of 512 elements with this command.

active-charging service p2p-detection attribute ssl-renegotiation

Specify the supported attribute of configurable P2P detection attributes populated from the currently loaded P2P plugin.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name )

Syntax

p2p-detection attribute ssl-renegotiation { [ id-reduce-factor id_reduce_factor ] [ max-entry-per-sessmgr max_entry_per_sessmgr ] } 

id-reduce-factor id_reduce_factor

Specify by what factor the SSL ID is stored in the SSL Session ID Tracker table.

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

max-entry-per-sessmgr max_entry_per_sessmgr

Specify maximum SSL Session IDs tracked per session manager.

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

Usage Guidelines

Configures the detection of SSL renegotiation flows. Use this command to specify the supported attribute of configurable P2P detection attributes populated from the currently loaded P2P plugin.

Example

The following command enables SSL renegotiation with SSL session IDs as 40000 and factor as 4:
p2p-detection attribute ssl-renegotiation max-entry-per-sessmgr 40000 id-reduce-factor 4 

active-charging service p2p-detection ecs-analysis

Enables or disables ACS analysis for all or specified analyzer.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name )

Syntax

p2p-detection ecs-analysis analyzer 

ecs-analysis analyzer

Specify the ACS analyzers.

Must be one of the following:

  • all : ACS analysis for all analyzers.

  • ftp : ACS analysis for FTP analyzer.

  • http : ACS analysis for HTTP analyzer.

  • https : ACS analysis for HTTPS analyzer.

  • rtsp : ACS analysis for RTSP analyzer.

  • sip : ACS analysis for SIP analyzer.

Usage Guidelines

Use this command to enable or disable ACS analysis for analyzers. This feature is enabled by default if P2P protocols are enabled.

Example

The following command enables ACS analysis for the FTP analyzer:
p2p-detection ecs-analysis ftp 

active-charging service p2p-detection protocol

Enables or disables the detection of all or specified peer-to-peer (P2P) protocols.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name )

Syntax

p2p-detection protocol p2p_protocol 

protocol p2p_protocol

Specify the P2P protocol.

Must be one of the following:

  • all

  • cisco-jabber

  • eros

  • fasttrack

  • googlemaps

  • skype

  • teamspeak

  • uber

  • ufc

  • yahoo

Usage Guidelines

Use this command to configure detection of all or specified P2P protocol.

Example

The following command enables detection of all P2P protocols:
p2p-detection protocol all 

active-charging service packet-filter

Configures ACS Packet Filter parameters.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name )

Syntax

packet-filter packet_filter_name 

direction direction

Specify the direction in which the current packet filter will be applied.

Must be one of the following:

  • bi-directional : Specify to apply the filter both in the uplink and downlink directions. This is the default value.

  • downlink : Specify to apply the filter only in the downlink direction.

  • uplink : Specify to apply the filter only in the uplink direction.

Default Value: bi-directional.

packet-filter packet_filter_name

Specify name of the packet filter.

Must be a string of 1-63 characters.

priority priority

Specify the priority of the packet filter.

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

Usage Guidelines

Use this command to configure ACS Packet Filter parameters.

active-charging service packet-filter ip local-port operator

Configures the port number of the local or remote transport protocol.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Packet Filter Configuration (config-service-packet-filter-packet_filter_name )

Syntax

ip local-port operator port_number 

Syntax

ip remote-port operator port_number 

operator

Specify how to match.

Must be one of the following:

  • = : Equals.

port_number

Specify the port number of the transport protocol.

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

Usage Guidelines

Configures the IP 5-tuple port(s) for the current packet filter. Use this command to configure the port number of the local or remote transport protocol.

active-charging service packet-filter ip local-port range

Configures a range of port numbers of the local or remote transport protocol.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Packet Filter Configuration (config-service-packet-filter-packet_filter_name )

Syntax

ip local-port range start_port_number to end_port_number 

Syntax

ip remote-port range start_port_number to end_port_number 

to end_port_number

Specify the ending port number for the port number range. The ending port number must be greater than the starting port number.

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

start_port_number

Specify the starting port number for the port number range. The starting port number must be lesser than the ending port number.

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

Usage Guidelines

Use this command to configure a range of port number of the local or remote transport protocol.

active-charging service packet-filter ip protocol

Configures the IP protocol(s) for the current packet filter.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Packet Filter Configuration (config-service-packet-filter-packet_filter_name )

Syntax

ip protocol operator protocol_number 

operator

Specify how to match.

Must be one of the following:

  • = : Equals.

protocol_number

Specify the protocol number.

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

Usage Guidelines

Configures the IP 5-tuple local port(s) for the current packet filter. Use this command to configure the protocol(s) for a packet filter.

Example

The following command configures the protocol assignment number 300:
ip protocol = 300 

active-charging service packet-filter ip remote-address

Configures the IP remote address(es) for the current packet filter.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Packet Filter Configuration (config-service-packet-filter-packet_filter_name )

Syntax

ip remote-address operator ip_address/mask 

ip_address_mask

Specify the IP address and mask.

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

-Or-

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

operator

Specify how to match.

Must be one of the following:

  • = : Equals.

Usage Guidelines

Configures the IP 5-tuple local port(s) for the current packet filter. Use this command to configure the remote address(es) for a packet filter.

Example

The following command configures the IP remote address as 10.2.3.4/24:
ip remote-address = 10.2.3.4/24 

active-charging service packet-filter ip remote-port operator

Configures the port number of the local or remote transport protocol.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Packet Filter Configuration (config-service-packet-filter-packet_filter_name )

Syntax

ip local-port operator port_number 

Syntax

ip remote-port operator port_number 

operator

Specify how to match.

Must be one of the following:

  • = : Equals.

port_number

Specify the port number of the transport protocol.

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

Usage Guidelines

Configures the IP 5-tuple port(s) for the current packet filter. Use this command to configure the port number of the local or remote transport protocol.

active-charging service packet-filter ip remote-port range

Configures a range of port numbers of the local or remote transport protocol.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Packet Filter Configuration (config-service-packet-filter-packet_filter_name )

Syntax

ip local-port range start_port_number to end_port_number 

Syntax

ip remote-port range start_port_number to end_port_number 

to end_port_number

Specify the ending port number for the port number range. The ending port number must be greater than the starting port number.

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

start_port_number

Specify the starting port number for the port number range. The starting port number must be lesser than the ending port number.

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

Usage Guidelines

Use this command to configure a range of port number of the local or remote transport protocol.

active-charging service packet-filter ip tos-traffic-class

Configures the type of service (TOS) traffic class under charging action in the Packet filter mode.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Packet Filter Configuration (config-service-packet-filter-packet_filter_name )

Syntax

ip tos-traffic-class tos_traffic_class_operator traffic_class mask mask_operator mask_field_value 

mask mask_operator

Specify how to match the specified mask.

Must be one of the following:

  • = : Equals.

mask_field_value

Specify the traffic-class mask field.

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

tos_traffic_class_operator

Specify how to match the specified TOS Traffic Class.

Must be one of the following:

  • = : Equals.

traffic_class

Specify the traffic class value to filter the traffic.

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

Usage Guidelines

Use this command to configure the TOS traffic class under charging action in the Packet filter mode.

active-charging service rulebase

Configures ACS rulebases.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name )

Syntax

rulebase rulebase_name [ retransmissions-counted | transactional-rule-matching ] 

retransmissions-counted { false | true }

Specify whether to count retransmissions in all charging modules.

Must be one of the following:

  • false

  • true

Default Value: true.

rulebase rulebase_name

Specify name of the rulebase. If the named rulebase does not exist, it is created, and the CLI mode changes to the ACS Rulebase Configuration Mode wherein the rulebase can be configured. If the named rulebase already exists, the CLI mode changes to the ACS Rulebase Configuration Mode for that rulebase.

Must be a string.

transactional-rule-matching

Specify to enable or disable transactional rule matching (TRM), which allows the ACS to bypass per-packet rule matching on a transaction once the transaction is fully classified.

Usage Guidelines

Use this command to create/configure an ACS rulebase. A rulebase is a collection of protocol rules to match a flow and associated actions to be taken for matching flow. The default rulebase is used when a subscriber/APN is not configured with a specific rulebase to use.

Example

The following command creates a rulebase named test1:
rulebase test1 

active-charging service rulebase action

Configures the action priority for a ruledef or group-of-ruledefs in the current rulebase.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

action priority action_priority { dynamic-only | static-and-dynamic | timedef timedef_name } 

Usage Guidelines

Use this command to configure action priorities for ruledefs / group-of-ruledefs in a rulebase. This CLI command can be entered multiple times to specify multiple ruledefs and charging actions. The ruledefs are examined in priority order, until a match is found and the corresponding charging action is applied.

Example

The following command assigns a rule and action with the action priority of 23, a ruledef named test, and a charging action named test1 to the current rulebase:
action priority 23 ruledef test charging-action test1 

active-charging service rulebase action priority

Configures priority for the specified ruledef or group-of-ruledefs in the current rulebase.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

priority action_priority 

priority action_priority

Specify the action priority.

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

Usage Guidelines

Use this command to assign priority to a rule in a rulebase.

active-charging service rulebase action priority dynamic-only

Enables matching of dynamic rules with static rules for this action priority on a flow.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

dynamic-only 

Usage Guidelines

Use this command to enable matching of dynamic rules with static rules for this action priority on a flow.

active-charging service rulebase action priority dynamic-only adc group-of-ruledefs

Assigns a group-of-ruledefs to the rulebase.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

adc ruledef ruledef_name { [ charging-action charging_action_name ] [ description description ] [ monitoring-key monitoring_key ] [ umid instance_id ] } 

Syntax

ruledef ruledef_name { [ charging-action charging_action_name ] [ description description ] [ monitoring-key monitoring_key ] [ umid instance_id ] } 

charging-action charging_action_name

Assigns the specified charging action to the rulebase.

Must be a string of 1-63 characters.

description description

Adds specified text to the rule and action.

Must be a string of 1-63 characters.

group-of-ruledefs group_of_ruledefs_name

Specify name of the group-of-ruledefs.

Must be a string of 1-63 characters.

monitoring-key monitoring_key

Associates the specified monitoring-key with ruledefs for usage monitoring.

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

umid um_id

Specify the Usage Monitoring Control Instance Identifier as required for usage reporting over N7.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to assign a group-of-ruledefs to the rulebase.

active-charging service rulebase action priority dynamic-only adc ruledef

Assigns ruledefs to the rulebase.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

ruledef ruledef_name { [ charging-action charging_action_name ] [ description description ] [ monitoring-key monitoring_key ] [ umid instance_id ] } 

charging-action charging_action_name

Assigns the specified charging action to the rulebase.

Must be a string of 1-63 characters.

description description

Adds specified text to the rule and action.

Must be a string of 1-63 characters.

monitoring-key monitoring_key

Associates the specified monitoring-key with ruledefs for usage monitoring.

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

ruledef ruledef_name

Specify name of the ruledef.

Must be a string of 1-63 characters.

umid um_id

Specify the Usage Monitoring Control Instance Identifier as required for usage reporting over N7.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to assign ruledefs to the rulebase.

active-charging service rulebase action priority dynamic-only group-of-ruledefs

Assigns a group-of-ruledefs to the rulebase.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

adc ruledef ruledef_name { [ charging-action charging_action_name ] [ description description ] [ monitoring-key monitoring_key ] [ umid instance_id ] } 

Syntax

ruledef ruledef_name { [ charging-action charging_action_name ] [ description description ] [ monitoring-key monitoring_key ] [ umid instance_id ] } 

charging-action charging_action_name

Assigns the specified charging action to the rulebase.

Must be a string of 1-63 characters.

description description

Adds specified text to the rule and action.

Must be a string of 1-63 characters.

group-of-ruledefs group_of_ruledefs_name

Specify name of the group-of-ruledefs.

Must be a string of 1-63 characters.

monitoring-key monitoring_key

Associates the specified monitoring-key with ruledefs for usage monitoring.

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

umid um_id

Specify the Usage Monitoring Control Instance Identifier as required for usage reporting over N7.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to assign a group-of-ruledefs to the rulebase.

active-charging service rulebase action priority dynamic-only ruledef

Assigns ruledefs to the rulebase.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

ruledef ruledef_name { [ charging-action charging_action_name ] [ description description ] [ monitoring-key monitoring_key ] [ umid instance_id ] } 

charging-action charging_action_name

Assigns the specified charging action to the rulebase.

Must be a string of 1-63 characters.

description description

Adds specified text to the rule and action.

Must be a string of 1-63 characters.

monitoring-key monitoring_key

Associates the specified monitoring-key with ruledefs for usage monitoring.

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

ruledef ruledef_name

Specify name of the ruledef.

Must be a string of 1-63 characters.

umid um_id

Specify the Usage Monitoring Control Instance Identifier as required for usage reporting over N7.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to assign ruledefs to the rulebase.

active-charging service rulebase action priority group-of-ruledefs

Assigns a group-of-ruledefs to the rulebase. Or, associates a time definition with a group-of-ruledefs.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

action priority action_priority static-and-dynamic group-of-ruledefs group_of_ruledefs_name 

Syntax

action priority action_priority timedef group-of-ruledefs group_of_ruledefs_name charging-action charging_action_name [ description description ] [ monitoring-key monitoring_key ] 

charging-action charging_action_name

Assigns the specified charging action to the rulebase.

Must be a string of 1-63 characters.

description description

Adds specified text to the rule and action.

Must be a string of 1-63 characters.

group-of-ruledefs group_of_ruledefs_name

Specify name of the group-of-ruledefs.

Must be a string of 1-63 characters.

monitoring-key monitoring_key

Associates the specified monitoring-key with ruledefs for usage monitoring.

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

Usage Guidelines

Use this command to assign a group-of-ruledefs to the rulebase. Or, associate a time definition with a group-of-ruledefs. Timedefs activate or deactivate groups-of-ruledefs, making them available for rule matching only when they are active.

active-charging service rulebase action priority ruledef

Assigns ruledefs to the rulebase. Or, associates a time definition with a ruledef.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

action priority action_priority static-and-dynamic ruledef ruledef_name charging-action charging_action_name ruledef ruledef_name [ description description ] [ monitoring-key monitoring_key ] 

Syntax

action priority action_priority timedef ruledef ruledef_name charging-action charging_action_name [ description description ] [ monitoring-key monitoring_key ] 

charging-action charging_action_name

Assigns the specified charging action to the rulebase.

Must be a string of 1-63 characters.

description description

Adds specified text to the rule and action.

Must be a string of 1-63 characters.

monitoring-key monitoring_key

Associates the specified monitoring-key with ruledefs for usage monitoring.

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

ruledef ruledef_name

Specify name of the ruledef.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to assign ruledefs to the rulebase. Or, associate a time definition with a ruledef. Timedefs activate or deactivate ruledefs, making them available for rule matching only when they are active.

active-charging service rulebase action priority static-and-dynamic group-of-ruledefs

Assigns a group-of-ruledefs to the rulebase. Or, associates a time definition with a group-of-ruledefs.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

action priority action_priority static-and-dynamic group-of-ruledefs group_of_ruledefs_name 

Syntax

action priority action_priority timedef group-of-ruledefs group_of_ruledefs_name charging-action charging_action_name [ description description ] [ monitoring-key monitoring_key ] 

charging-action charging_action_name

Assigns the specified charging action to the rulebase.

Must be a string of 1-63 characters.

description description

Adds specified text to the rule and action.

Must be a string of 1-63 characters.

group-of-ruledefs group_of_ruledefs_name

Specify name of the group-of-ruledefs.

Must be a string of 1-63 characters.

monitoring-key monitoring_key

Associates the specified monitoring-key with ruledefs for usage monitoring.

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

Usage Guidelines

Use this command to assign a group-of-ruledefs to the rulebase. Or, associate a time definition with a group-of-ruledefs. Timedefs activate or deactivate groups-of-ruledefs, making them available for rule matching only when they are active.

active-charging service rulebase action priority static-and-dynamic ruledef

Assigns ruledefs to the rulebase. Or, associates a time definition with a ruledef.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

action priority action_priority static-and-dynamic ruledef ruledef_name charging-action charging_action_name ruledef ruledef_name [ description description ] [ monitoring-key monitoring_key ] 

Syntax

action priority action_priority timedef ruledef ruledef_name charging-action charging_action_name [ description description ] [ monitoring-key monitoring_key ] 

charging-action charging_action_name

Assigns the specified charging action to the rulebase.

Must be a string of 1-63 characters.

description description

Adds specified text to the rule and action.

Must be a string of 1-63 characters.

monitoring-key monitoring_key

Associates the specified monitoring-key with ruledefs for usage monitoring.

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

ruledef ruledef_name

Specify name of the ruledef.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to assign ruledefs to the rulebase. Or, associate a time definition with a ruledef. Timedefs activate or deactivate ruledefs, making them available for rule matching only when they are active.

active-charging service rulebase action priority timedef group-of-ruledefs

Assigns a group-of-ruledefs to the rulebase. Or, associates a time definition with a group-of-ruledefs.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

action priority action_priority static-and-dynamic group-of-ruledefs group_of_ruledefs_name 

Syntax

action priority action_priority timedef group-of-ruledefs group_of_ruledefs_name charging-action charging_action_name [ description description ] [ monitoring-key monitoring_key ] 

charging-action charging_action_name

Assigns the specified charging action to the rulebase.

Must be a string of 1-63 characters.

description description

Adds specified text to the rule and action.

Must be a string of 1-63 characters.

group-of-ruledefs group_of_ruledefs_name

Specify name of the group-of-ruledefs.

Must be a string of 1-63 characters.

monitoring-key monitoring_key

Associates the specified monitoring-key with ruledefs for usage monitoring.

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

Usage Guidelines

Use this command to assign a group-of-ruledefs to the rulebase. Or, associate a time definition with a group-of-ruledefs. Timedefs activate or deactivate groups-of-ruledefs, making them available for rule matching only when they are active.

active-charging service rulebase action priority timedef ruledef

Assigns ruledefs to the rulebase. Or, associates a time definition with a ruledef.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

action priority action_priority static-and-dynamic ruledef ruledef_name charging-action charging_action_name ruledef ruledef_name [ description description ] [ monitoring-key monitoring_key ] 

Syntax

action priority action_priority timedef ruledef ruledef_name charging-action charging_action_name [ description description ] [ monitoring-key monitoring_key ] 

charging-action charging_action_name

Assigns the specified charging action to the rulebase.

Must be a string of 1-63 characters.

description description

Adds specified text to the rule and action.

Must be a string of 1-63 characters.

monitoring-key monitoring_key

Associates the specified monitoring-key with ruledefs for usage monitoring.

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

ruledef ruledef_name

Specify name of the ruledef.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to assign ruledefs to the rulebase. Or, associate a time definition with a ruledef. Timedefs activate or deactivate ruledefs, making them available for rule matching only when they are active.

active-charging service rulebase bandwidth

Configures rulebase bandwidth policy parameters.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

bandwidth default-policy default_firewall_policy_name 

default-policy default_firewall_policy_name

Specify the default firewall policy.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to configure the rulebase bandwidth policy parameter for default firewall policy.

active-charging service rulebase billing-records

Configures the type of billing to be performed for subscriber sessions.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

billing-records { [ egcdr ] [ radius ] [ rf ] } 

egcdr

Generates an enhanced G-CDR (eG-CDR) for GGSN / P-GW-CDR for P-GW, and/or UDR with specified format on the occurrence of an interim trigger condition at the end of a subscriber session, or an SGSN-to-SGSN handoff

radius

Generates postpaid RADIUS accounting records at the start and end of a subscriber session, and on the occurrence of an interim trigger condition. RADIUS accounting records are generated for each content ID.

rf

Specify to enable Rf accounting.

Usage Guidelines

Use this command to generate enhanced G-CDRs (eG-CDRs), P-GW-CDR for P-GW, RADIUS CDRs and/or UDRs for billing records. The format of eG-CDRs for the default GTPP group is controlled by the inspector command in the Context Configuration Mode.

active-charging service rulebase billing-records udr

Generates Usage Data Record (UDR) with specified the format on the occurrence of an interim trigger condition, at the end of a subscriber session, or a handoff.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

billing-records udr udr-format udr_format_name 

udr-format udr_format_name

Specify name of the UDR format.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to enable Usage Data Record.

Example

The following command sets the billing record to UDR with UDR format named udr_format1:
billing-records udr udr-format udr_format1 

active-charging service rulebase cca diameter requested-service-unit sub-avp time

Configures the ACS Diameter Credit Control Requesting Service Unit - time values.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

cca diameter requested-service-unit sub-avp time cc-time cc_time 

cc-time cc_time

Specify requested service unit for charging time duration in seconds in included sub-AVP.

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

Usage Guidelines

Configures the Diameter sub-AVPs to be included in "Requested-Service-Unit", the Diameter group AVP sent with DCCA Credit Control Requests (CCRs). Use this command to configure the ACS Diameter Credit Control requesting service unit - time values.

active-charging service rulebase cca diameter requested-service-unit sub-avp units

Configures ACS Diameter Credit Control Requesting Service Unit - Service-specific values.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

cca diameter requested-service-unit sub-avp units cc-service-specific-units charging_unit 

cc-service-specific-units charging_unit

Specify the service-specific charging units.

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

Usage Guidelines

Configures sub-AVP of the Requested-Service-Unit AVP. Use this command to configure the ACS Diameter Credit Control Requesting Service Unit - Service-specific values.

active-charging service rulebase cca diameter requested-service-unit sub-avp volume

Configures the ACS Diameter Credit Control Requesting Service Unit - Time values.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

cca diameter requested-service-unit sub-avp volume { [ cc-input-octets cc_input_octets ] [ cc-output-octets cc_output_octets [ cc-total-octets cc_total_octets ] } 

cc-input-octets cc_input_octets

Specify the volume in bytes.

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

cc-output-octets cc_output_octets

Specify the output charging octets in bytes.

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

cc-total-octets cc_total_octets

Specify the total charging octets in bytes.

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

Usage Guidelines

Configures sub-AVP of the Requested-Service-Unit AVP. Use this command to configure the ACS Diameter Credit Control Requesting Service Unit - Time values.

active-charging service rulebase cca quota holding-time

Configures the Quota Holding Time (QHT). QHT is used with both time- and volume-based quotas.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

cca quota holding-time holding_time content-id content_id 

content-id content_id

Specify the content ID (Rating group AVP) to use for the Quota holding time for the current rulebase. Must be the content ID specified for Credit Control Service in the ACS.

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

holding-time holding_time

Specify the holding time.

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

Usage Guidelines

Configures various time and threshold-based quotas in the Prepaid Credit Control Service (Credit Control Application). Use this command to configure the value for the Quota Holding Time (QHT). QHT is used with both time- and volume-based quotas. After the configured number of seconds has passed without user traffic, the quota is reported back and the charging stops until new traffic starts.

active-charging service rulebase cca quota retry-time

Configures the retry time for the quota request.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

cca quota retry-time retry_time [ max-retries max_retries ] 

max-retries max_retries

Specify the maximum number of retries allowed for blacklisted categories.

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

retry-time retry_time

Specify the retry interval in seconds.

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

Usage Guidelines

Use this command to configure credit control quota retry time.

active-charging service rulebase cca quota time-duration

Configures the algorithm to compute time duration for Prepaid Credit Control Application quotas in the current rulebase.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

cca quota time-duration algorithm { consumed-time consumed_time [ plus-idle ] | continuous-time-periods continuous_time_periods | parking-meter parking_meter } [ content-id content_id ] 

algorithm

Specify the Credit Control Quota Time Duration algorithm.

consumed-time consumed_time

Specify the Credit Control consumed time.

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

content-id content_id

Specify the Content ID.

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

continuous-time-periods continuous_time_periods

Specify the continuous time periods.

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

parking-meter parking_meter

Specify the Credit Control Parking Meter.

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

plus-idle

Specify the Credit Control idle time.

Usage Guidelines

Use this command to configure the various time charging algorithms/schemes for prepaid credit control charging. If operator chooses parking-meter style charging, then time is billed in seconds chunks.

Example

The following command configures the QCT to consumed-time duration of 400 seconds:
cca quota time-duration algorithm consumed-time 400 

active-charging service rulebase content-filtering category

Configures the Content Filtering Category Policy Identifier for Policy-based Content Filtering support in the current rulebase.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

content-filtering category policy-id cf_policy_id 

policy-id cf_policy_id

Specify the Content Filtering Policy ID.

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

Usage Guidelines

Use this command to configure the Content Filtering Category Policy ID for Policy-based Content Filtering support in the rulebase.

Example

The following command configures the Content Filtering Category Policy ID 101 in the rulebase:
content-filtering category policy-id 101 

active-charging service rulebase content-filtering flow-any-error

Configures the action to take on Content Filtering packets in the case of ACS error scenarios.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

content-filtering flow-any-error { deny | permit } 

deny

Specify the flow-any-error configuration as deny. All the denied packets will be accounted for by the discarded-flow-content-id configuration in the Content Filtering Policy Configuration Mode. This content ID will be used to generate UDRs for packets denied via content filtering.

permit

Specify the flow-any-error configuration as permit.

Usage Guidelines

Use this command to allow/discard content filtering packets in case of ACS error scenarios.

Example

The following command allows content filtering packets in case of an ACS error:
content-filtering flow-any-error permit 

active-charging service rulebase content-filtering mode

Enables or disables the specified Category-based Content Filtering mode in the current rulebase.

Syntax

content-filtering mode { category { static-and-dynamic | static-only } | server-group cf_server_group_name } 

category { static-and-dynamic | static-only }

Using Category-based Content Filtering support requires Content Filtering Category configuration in the Global Configuration Mode.

Must be one of the following:

  • static-and-dynamic : Configures Category-based Content Filtering in Static-and-Dynamic mode, wherein a static rating of the URL is first performed, and only if the static rating fails to find a match, dynamic rating of the content that the server returns is then performed.

  • static-only : Configures Category-based Content Filtering in static only mode, wherein all URLs are compared against an internal database to categorize the requested content.

server-group server_group_name

Specify name of the Content Filtering Server Group.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to enable and apply the content filtering mode in the rulebase to manage a content filtering server with an ICAP client system.

Example

The following command enables the content filtering mode for external content filtering server group cf_server1 in the rulebase:
content-filtering mode server-group cf_server1 

active-charging service rulebase credit-control-group

Configures the credit control group to be used for subscribers who use this rulebase.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

credit-control-group cc_group_name 

credit-control-group cc_group_name

Specify name of the credit control group.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to specify the desired CC group whenever the rulebase is selected during the subscriber session setup. This is an optional CLI configuration, and used only when customized Assume Positive behavior is required for subscribers. This CLI configuration is applicable only during the session setup. Mid-session change in the CC group is not allowed.

Example

The following command configures the association of a credit-control group named test for the current rulebase:
credit-control-group test 

active-charging service rulebase dynamic-rule

Configfures whether dynamic rules are matched before statically configured rules.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

dynamic-rule order dynamic_rule_order 

order dynamic_rule_order

Specify dynamic rule order.

Must be one of the following:

  • always-first : Specify to match all the dynamic rules against the flow prior to any static rule. This is the default value.

  • first-if-tied : Specify to match rules against the flow based on their priority with the condition that dynamic rules match before a static rule of the same priority. A rule is a combination of a ruledef, charging action, and precedence. Static rules are defined by the "action" CLI command in the ACS Rulebase Configuration Mode, and are applicable to all subscribers that are associated with the rulebase. Dynamic rules are obtained via a dynamic protocol, such as, the Gx-interface for a particular subscriber session.

Usage Guidelines

Use this command to configure the order in which rules are selected for matching in between dynamic rules (per subscriber) and static rules (from rulebase).

Example

The following command matches all dynamic rules against the flow prior to any static rule:
dynamic-rule order always-first 

active-charging service rulebase edr transaction-complete

Configures EDR-related parameters.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

edr transaction-complete { dns | http } [ charging-edr charging_edr_format_name | edr-format edr_format_name | reporting-edr reporting_edr_format_name ] 

charging-edr charging_edr_format_name

Specify to generate charging EDR on transaction completion.

Must be a string of 1-63 characters.

dns

DNS protocol-related configuration.

edr-format edr_format_name

Specify to generate EDR on transaction completion for DNS or HTTP protocol.

Must be a string of 1-63 characters.

http

HTTP protocol-related configuration.

reporting-edr reporting_edr_format_name

Specify the reporting EDR format name to generate reporting EDR on transaction completion.

Must be a string of 1-63 characters.

Usage Guidelines

Configures the generation of an EDR on the completion of a transaction. Use this command to configure the generation of an EDR when certain application transactions (for example, request/response pairs) complete. EDR generation is supported for DNS or HTTP protocol. Note that these EDRs are in addition to those that might be generated due to other conditions, for example, EDR configurations in a charging action.

Example

The following command configures the generation of charging EDRs on the completion of transactions for HTTP protocol specifying the EDR format as test123:
edr transaction-complete http charging-edr test123 

active-charging service rulebase egcdr threshold

Assigns volume or interval values to the interim G-CDRs.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

egcdr threshold interval duration 

interval duration

Specify the time interval, in seconds, for closing the G-CDR/PGW-CDR if the minimum time duration thresholds are satisfied.

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

Usage Guidelines

Configures the thresholds for generating eG-CDRs for GGSN and PGW-CDRs for P-GW. Use this command to assign the interval values to the interim G-CDRs.

Example

The following command defines an eG-CDR threshold interval of 600 seconds:
egcdr threshold interval 600 

active-charging service rulebase egcdr threshold volume

Configures the uplink/downlink volume octet counts for the generation of the interim G-CDRs/PGW-CDRs.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

egcdr threshold volume { downlink | total | uplink } bytes 

downlink bytes

Specify the limit for the number of downlink (from network to subscriber) octets after which the G-CDR/PGW-CDR is closed.

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

total bytes

Specify the limit for the total number of octets (uplink+downlink) after which the G-CDR/PGW-CDR is closed.

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

uplink bytes

Specify the limit for the number of uplink (from subscriber to network) octets after which the G-CDR/PGW-CDR is closed.

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

Usage Guidelines

Configures the thresholds for generating G-CDRs and PGW-CDRs. Use this command to configure the uplink/downlink volume octet counts for the generation of the interim G-CDRs.

active-charging service rulebase flow control-handshaking

Specify control protocol handshake packets.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

flow control-handshaking charge-separate-from-application 

charge-separate-from-application

Specify the charging action to separate the charging of the initial control packets or all subsequent control packets from regular charging.

Usage Guidelines

Configures the charge for the control traffic associated with an application. Use this command to specify control protocol handshake packets.

active-charging service rulebase flow control-handshaking charge-to-application

Configures the charging action to include the flow control packets either during initial handshaking only or specified control packets during session for charging.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

flow control-handshaking charge-to-application { [ all-packets ] [ initial-packets ] [ mid-session-packets ] [ tear-down-packets ] } 

all-packets

Specify that the initial setup packets will wait until the application has been determined before assigning the content-id, and all mid-session ACK packets as well as the final tear-down packets will use that content-id.

initial-packets

Specify that only the initial setup packets will wait for content-id assignment.

mid-session-packets

Specify that the ACK packets after the initial setup will use the application's or content-id assignment.

tear-down-packets

Specify that the final tear-down packets (TCP or WAP) will use the application's or content-id assignment.

Usage Guidelines

Use this command to charge control packets to application ruledefs.

active-charging service rulebase flow end-condition

Configures the end condition of the session flows related to a user session and triggers EDR generation.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

flow end-condition { normal-end-signaling | session-end | timeout } [ charging-edr charging_edr_format_name ] 

charging-edr charging_edr_format_name

Specify name of the charging EDR format.

Must be a string of 1-63 characters.

normal-end-signaling

Creates an EDR with the specified EDR format whenever flow end is signaled normally, for example like detecting FIN and ACK for a TCP flow, or a WSP-DISCONNECT terminating a connection-oriented WSP flow over UDP) and create an EDR for the flow using the specified EDR format.

session-end

Creates an EDR with the specified EDR format whenever a subscriber session ends. By this option ACS creates an EDR with the specified format name for every flow that has had any activity since last EDR was created for the flow on session end.

timeout

Creates an EDR with the specified EDR format whenever a flow ends due to a timeout condition.

Usage Guidelines

Use this command to enable or disable the capturing of EDRs based on flow end condition.

active-charging service rulebase flow limit-across-applications

This command allows you to limit the total number of simultaneous flows per Subscriber/APN sent to a rulebase regardless of the flow type, or limit flows based on the protocol type under the Session Control feature.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

flow limit-across-applications { limit | non-tcp non_tcp_limit | tcp tcp_limit } 

non-tcp non_tcp_limit

Specify the maximum limit of non-TCP type flows.

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

tcp tcp_limit

Specify the maximum limit of TCP flows.

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

limit

Specify the maximum limit.

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

Usage Guidelines

Use this command to limit the total number of flows allowed per subscriber for a rulebase regardless of flow type, or limit flows based on the protocol non-TCP (connection-less) or TCP (connection-oriented).

Example

The following command configures the maximum number of 200000 flows for the rulebase:
flow limit-across-applications 200000 

active-charging service rulebase ip

Configures IP parameters related to user session.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

ip reassembly-timeout reassembly_timeout 

reassembly-timeout reassembly_timeout

Specify the maximum duration for which ip packet fragments are retained, in milliseconds.

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

Default Value: 5000.

Usage Guidelines

Use this command to configure IP parameters related to user session.

active-charging service rulebase p2p

Enables or disables the P2P analyzer to detect peer-to-peer (P2P) applications.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

p2p dynamic-flow-detection 

dynamic-flow-detection

Enables dynamic-flow detection, allowing the P2P analyzer to detect the P2P applications configured for the ACS.

Usage Guidelines

Use this command to enable/disable the P2P analyzer to detect peer-to-peer (P2P) applications.

active-charging service rulebase post-processing priority

Configures the post-processing priority of a specific ruledef in the current rulebase.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

post-processing priority post_processing_priority 

priority post_processing_priority

Specify the post-processing priority.

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

Usage Guidelines

Use this command to configure the post-processing priority of a specific ruledef in the current rulebase.

Example

The following command configures the ruledef named test_ruledef with a priority of 10:
post-processing priority 10 

active-charging service rulebase post-processing priority group-of-ruledefs

Configures group-of-ruledefs parameters.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

post-processing priority post_processing_priority group-of-ruledefs group_of_ruledefs_name charging-action charging_action [ description description ] 

charging-action charging_action_name

Specify name of the charging action.

Must be a string of 1-63 characters.

description description

Specify an optional description for this configuration.

Must be a string of 1-63 characters.

group-of-ruledefs group_of_ruledefs_name

Specify name of the group-of-ruledefs.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to configure group-of-ruledefs parameters.

active-charging service rulebase post-processing priority ruledef

Assigns ruledefs to the current rulebase.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

post-processing priority post_processing_priority ruledef ruledef_name charging-action charging_action_name [ description description ] 

charging-action charging_action_name

Specify name of the charging action.

Must be a string of 1-63 characters.

description description

Specify an optional description for this configuration.

Must be a string of 1-63 characters.

ruledef ruledef_name

Specify name of the ruledef.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to assign ruledefs to the current rulebase.

active-charging service rulebase route priority

Configures the priority of the route in the rulebase.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

priority route_priority 

priority route_priority

Specify the route priority.

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

Usage Guidelines

Configures the routing of packets to protocol analyzers. Use this command to configure the priority of the route in the rulebase.

active-charging service rulebase route priority ruledef

Configures the ruledef to evaluate packets to determine analyzer.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

route priority route_priority ruledef ruledef_name analyzer analyzer 

analyzer analyzer

Specify the analyzer for the ruledef.

Must be one of the following:

  • dns : Route to DNS protocol.

  • file-transfer : Route to file analyzer.

  • ftp-control : Route to FTP Control protocol.

  • ftp-data : Route to FTP Data protocol.

  • h323 : Route to H323 protocol.

  • http : Route to HTTP protocol.

  • imap : Route to IMAP protocol analyzer.

  • mipv6 : Route to MIPv6 protocol analyzer.

  • mms : Route to MMS protocol analyzer.

  • pop3 : Route to POP3 protocol analyzer.

  • pptp : Route to PPTP protocol analyzer.

  • radius : Route to light-weight RADIUS protocol analyzer.

  • rtcp : Route to RTCP protocol analyzer.

  • rtp : Route to RTP protocol analyzer.

  • rtsp : Route to RTSP protocol analyzer.

  • sdp : Route to SDP protocol analyzer.

  • secure-http : Route to secure HTTP protocol analyzer.

  • sip : Route to SIP protocol analyzer.

  • smtp : Route to SMTP protocol analyzer.

  • tftp : Route to TFTP protocol analyzer.

  • wsp-connection-less : Route to WSP connection-less protocol analyzer.

  • wsp-connection-oriented : Route to WSP connection-oriented protocol analyzer.

description description

Specify to add a description to the rule and action in the saved configuration file for later reference.

Must be a string of 1-31 characters.

ruledef ruledef_name

Specify name of the ruledef.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to assign a ruledef to a rulebase,

active-charging service rulebase rtp

Configures the Real Time Streaming Protocol (RTSP) and Session Description Protocol (SDP) analyzers to detect the start/stop of RTP and RTCP flows.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

rtp dynamic-flow-detection 

dynamic-flow-detection

Specify to enable dynamic RTP/RTCP flow detection.

Usage Guidelines

Use this command to enable the RTSP and SDP analyzers to detect the start/stop of RTP and RTCP flows. This command is used in conjunction with the route priority command.

active-charging service rulebase tcp

Configures TCP window size checking.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

tcp check-window-size 

check-window-size

Specify to enable TCP window-size checking.

Usage Guidelines

Use this command to enable/disable TCP window-size check for packets out of TCP window.

Example

The following command enables TCP window-size check:
tcp check-window-size 

active-charging service rulebase tcp mss

Configures the TCP Maximum Segment Size (MSS) in TCP SYN packets.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

tcp mss tcp_mss { [ add-if-not-present ] [ limit-if-present ] } 

add-if-not-present

Specify to add the TCP MSS if not present in the packet.

limit-if-present

Specify to limit the TCP MSS if present in the packet.

mss tcp_mss

Specify the TCP MSS.

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

Usage Guidelines

Using this command, TCP MSS can be limited if already present in the TCP SYN packets. If there are no errors detected in IP header/TCP mandatory header and there are no memory allocation failures, TCP optional header is parsed. If TCP MSS is present in the optional header and its value is greater than the configured MSS value, the value present in the TCP packet is replaced with the configured one.

Example

The following command limits the TCP maximum segment size to 3000, and if not present adds it to the packets:
tcp mss 3000 limit-if-present add-if-not-present 

active-charging service rulebase tcp packets-out-of-order

Configures processing of TCP packets that are out of order, while waiting for the earlier packet(s) to arrive.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

tcp packets-out-of-order timeout timeout_duration 

timeout timeout_duration

Specify the timeout duration for re-assembly of TCP out-of-order packets in milliseconds.

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

Default Value: 5000.

Usage Guidelines

Use this command to configure how to process TCP packets that are out of order, while waiting for the earlier packet(s) to arrive.

Example

The following command sets the timeout timer to 10000 milliseconds:
tcp packets-out-of-order timeout 10000 

active-charging service rulebase tcp packets-out-of-order transmit

Configures the TCP out-of-order segment behavior after buffering a copy.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

tcp packets-out-of-order transmit transmit_behavior 

transmit transmit_behavior

Specify the TCP out-of-order segment behavior after buffering a copy.

Must be one of the following:

  • after-reordering : Specify to deliver the TCP out-of-order segments in-sequence to the ACS analyzer after all packets are received and successfully reordered. The "after-reordering" option is doing this by buffering out-of-order packets, and only releasing them after the missing out-of-order packets are received (or after OOO timeout). When the missing packet is received, complete deep packet inspection of all the packets and all relevant in-line services is done, and then the last packet is forwarded (as the latest). If reordering is not successful within the specified OOO timeout, all the subsequent received packets in that TCP flow are forwarded without being passed through the analysers (except the L3/L4 analyzer). As a consequence, only L3/L4 rule matching will take place. If memory allocation fails or the received packet is partial retransmitted data, the packet will also be forwarded immediately without being passed through the protocol analyzers, except for the L3/L4 analyzers.

  • immediately : Specify to deliver the TCP out-of-order segments in-sequence to the ACS analyzer after all packets are received and successfully reordered. The "immediately" option is accomplishing this by making a copy of out-of-order packets, and buffering those, while transmitting the original data packets through the outgoing interface immediately. When the missing packet is received, complete deep packet inspection of all the packets and all relevant in-line services is done, and then the last packet is forwarded. If reordering of the buffered packets is not successful within the specified OOO timeout, all the subsequent received packets in that TCP flow are forwarded without being passed through the analysers (except the L3/L4 analyzer). As a consequence only L3/L4 rule matching will take place. If memory allocation fails or the received packet is partial retransmitted data, the packet will also be forwarded immediately without being passed through the protocol analyzers, except for the L3/L4 analysers.

Usage Guidelines

Use this command to configure the TCP out-of-order segment behavior after buffering a copy.

active-charging service rulebase tethering-detection

Enables or disables the Tethering Detection feature for the current rulebase, and specifies the database to use.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

tethering-detection { application | dns-based | ip-ttl-value ttl_value | max-syn-packet-in-flow max_syn_packets | tethering_database } 

application

Specify to perform tethering detection based on App-based method.

dns-based

Specify to perform tethering detection based on DNS-based method.

max-syn-packet-in-flow max_syn_packets

Specify the number of SYN packets applicable for tethering detection in a flow.

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

tethering_database

Specify to perform tethering detection using the specified database.

Must be one of the following:

  • os-db-only : Specify to perform tethering detection using IPv4 and IPv6 OS signature databases.

  • os-ua-db : Specify to perform tethering detection using IPv4 OS, IPv6 OS, and UA signature databases.

  • ua-db-only : Specify to perform tethering detection using only the UA signature database.

Usage Guidelines

Use this command to enable/disable the Tethering Detection feature for a rulebase, and configures the database to use. Tethering Detection can be done for IPv4, IPv6, TCP and UDP flows.

Example

The following command enables the Tethering Detection feature in the rulebase, and specifies to use only the OS database:
tethering-detection os-db-only 

active-charging service rulebase url-blacklisting action

Configures URL Blacklisting action.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

url-blacklisting action { discard | redirect-url redirect_url | terminate-flow | www-reply-code-and-terminate-flow reply_code } [ content-id content_id ] 

content-id content_id

Specify the content ID, a number assigned to URL Blacklisting.

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

discard

Specify the URL Blacklisting action as "discard".

redirect-url redirect_url

Specify the redirect URL/URI, which must be a fully qualified URL/URI.

Must be a string.

terminate-flow

Specify the URL Blacklisting action as "terminate-flow".

www-reply-code-and-terminate-flow reply_code

Specify the URL Blacklisting action as "terminate-flow action with reply code".

Must be an integer in the range of 400-599.

Usage Guidelines

Enables or disables URL Blacklisting functionality for the current rulebase, and configures the action to be taken when there is a URL match. Use this command to configure the URL Blacklisting action.

active-charging service rulebase url-blacklisting match-method

Configures URL Blacklisting match-method.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Rulebase Configuration (config-rulebase-rulebase_name )

Syntax

url-blacklisting match-method match_method 

match-method match_method

Specify the match method.

Must be one of the following:

  • exact : URL Blacklisting performs an exact match of URL.

  • generic : URL Blacklisting performs generic match of URL.

Usage Guidelines

Use this command to configure the URL Blacklisting match method.

active-charging service ruledef

Configures ACS rule definitions (ruledef).

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name )

Syntax

ruledef ruledef_name [ rule-application ruledef_purpose ] 

rule-application ruledef_purpose

Specify the purpose of the ruledef. When a ruledef is evaluated, if the multi-line-or all-lines command is configured, the logical OR.

Must be one of the following:

  • charging : Specify that the current ruledef is for charging purposes.

  • post-processing : Specify that the current ruledef is for post-processing purposes. This enables processing of packets even if the rule matching for them has been disabled.

  • routing : Specify that the current ruledef is for routing purposes. Up to 256 ruledefs can be defined for routing in an ACS.

ruledef ruledef_name

Specify name of the ruledef. If the named ruledef does not exist, it is created, and the CLI mode changes to the ACS Ruledef Configuration Mode wherein the ruledef can be configured. If the named ruledef already exists, the CLI mode changes to the ACS Ruledef Configuration Mode for that ruledef.

Must be a string.

Usage Guidelines

Use this command to create/configure an ACS ruledef. A ruledef represents a set of matching conditions across multiple L3 L7 protocol based on protocol fields and state information. Each ruledef can be used across multiple rulebases within the ACS.

Example

The following command creates/configures an ACS ruledef named test1:
ruledef test1 

active-charging service ruledef bearer service-3gpp rat-type

Specify RAT type associated with the bearer flow.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

bearer service-3gpp rat-type operator rat_type 

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • = : Equals.

rat_type

Specify the RAT type.

Must be one of the following:

  • geran : GSM EDGE Radio Access Network type.

  • utran : UMTS Terrestrial Radio Access Network type.

  • wlan : Wireless LAN type.

Usage Guidelines

Configures rule expression to match Radio Access Technology (RAT) in the bearer flow. Use this command to configure the RAT type associated with the bearer flow.

active-charging service ruledef dns answer-name

Configures ruledef to match DNS answer name.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

dns answer-name operator value 

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • !contains : Does not contains.

  • !ends-with : Does not end with.

  • !starts-with : Does not start with.

  • = : Equals.

  • case-sensitive : Strings will be matched in case-sensitive manner.

  • contains : Contains.

  • ends-with : Ends with.

  • starts-with : Starts with.

value

Specify the value.

Must be a string of 1-127 characters.

Usage Guidelines

Configures ruledef to match answer name in the answer section of DNS response messages.

active-charging service ruledef dns any-match

Configures rule expression to match all packets of the specified protocol.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

dns any-match operator condition 

Syntax

icmpv6 any-match operator condition 

Syntax

rtp any-match operator condition 

Syntax

rtsp any-match operator condition 

Syntax

secure-http any-match operator condition 

Syntax

tcp any-match operator condition 

Syntax

udp any-match operator condition 

Syntax

wsp any-match operator condition 

Syntax

wtp any-match operator condition 

condition

Specify the condition.

Must be one of the following:

  • FALSE

  • TRUE

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • = : Equals.

Usage Guidelines

Use this command to configure rule expression to match all packets of a specified protocol.

Example

The following command defines a rule expression to match all RTP packets:
rtp any-match = TRUE 

active-charging service ruledef dns previous-state

Configures rule expression to match previous state of the DNS FSM.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

dns previous-state operator previous_state 

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • = : Equals.

previous_state

Specify the previous state to match.

Must be one of the following:

  • dns-timeout : DNS timeout.

  • init : Init.

  • req-sent : Request sent.

  • resp-error : Response error.

  • resp-success : Response success.

Usage Guidelines

Use this command to define rule expressions to match previous state of DNS FSM.

Example

The following command defines a rule expression to match the DNS FSM previous state "req-sent":
dns previous-state = req-sent 

active-charging service ruledef dns query-name

Configures rule expression to match query name in DNS request messages.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

dns query-name [ case-sensitive ] operator query_name 

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • !contains : Does not contain.

  • !ends-with : Does not end with.

  • !starts-with : Does not start with.

  • = : Equals.

  • case-sensitive : Strings will be matched in case-sensitive manner.

  • contains : Contains.

  • ends-with : Ends with.

  • starts-with : Starts with.

query_name

Specify the query name to match.

Must be a string of 1-127 characters.

Usage Guidelines

Use this command to define rule expressions to match query name in DNS request messages.

Example

The following command defines a rule expression to match DNS query name "test":
dns query-name = test 

active-charging service ruledef dns query-type

Configures rule expression to match the query type in the DNS request messages.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

dns query-type operator query_type 

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • = : Equals.

query_type

Specify the DNS query type to match.

Must be one of the following:

  • a : Support query-type A.

  • aaaa : Support query-type AAAA.

  • cname : Support query-type CNAME.

  • ns : Support query-type NS.

  • null : Support query-type NULL.

  • ptr : Support query-type PTR.

  • srv : Support query-type SRV.

  • txt : Support query-type TXT.

Usage Guidelines

Use this command to define rule expressions to match the query type in the DNS request messages.

Example

The following command defines a rule expression to match the DNS query type "txt":
dns query-type = txt 

active-charging service ruledef dns return-code

Configures rule expression to match response code in DNS response messages.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

dns return-code operator return_code 

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • = : Equals.

return_code

Specify the response code to match.

Must be one of the following:

  • format-error : DNS response: Format Error.

  • name-error : DNS response: Name Error.

  • no-error : DNS response: No Error.

  • not-implemented : DNS response: Name server does not support the requested query.

  • refused : DNS response: Refused to perform specified operation.

  • server-failure : DNS response: Server Failure.

Usage Guidelines

Use this command to define rule expressions to match response code in DNS response messages.

Example

The following command defines a rule expression to match a DNS response code "refused":
dns return-code = refused 

active-charging service ruledef dns state

Configures rule expressions to match current state of DNS FSM.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

dns state operator current_state 

current_state

Specify the state to match.

Must be one of the following:

  • dns-timeout

  • init

  • req-sent

  • resp-error

  • resp-success

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • = : Equals.

Usage Guidelines

Use this command to define rule expressions to match DNS FSM current state.

Example

The following command defines a rule expression to match DNS FSM current state of "req-sent":
dns state = req-sent 

active-charging service ruledef dns tid

Configures rule expressions to match Transaction Identifier (TID) field in DNS messages.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

dns tid operator tid_value 

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • >= : Greater than or equals.

  • <= : Lesser than or equals.

  • = : Equals.

tid_value

Specify the DNS TID field value to match.

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

Usage Guidelines

Use this command to define rule expressions to match a TID field of DNS messages.

Example

The following command defines a rule expression to match DNS TID field value of "test":
dns tid = test 

active-charging service ruledef http content type

Configures rule expression to match value in HTTP Content-Type entity-header field.

Syntax

http content type [ case-sensitive ] operator content_type 

case-sensitive

Specify the rule expression must be case-sensitive. By default, rule expressions are not case-sensitive.

content_type

Specify the content type to match.

Must be a string of 1-127 characters.

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • !contains : Does not contain.

  • !ends-with : Does not end with.

  • !starts-with : Does not start with.

  • = : Equals.

  • contains : Contains.

  • ends-with : Ends with.

  • starts-with : Starts with.

Usage Guidelines

Use this command to configure rule expressions to match HTTP content type.

active-charging service ruledef http host

Configures rule expression to match value in HTTP Host Request header field.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

http host [ case-sensitive ] operator host_name 

case-sensitive

Specify the rule expression must be case-sensitive. By default, rule expressions are not case-sensitive.

host_name

Specify the host name to match.

Must be a string of 1-127 characters.

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • !contains : Does not contain.

  • !ends-with : Does not end with.

  • !starts-with : Does not start with.

  • = : Equals.

  • contains : Contains.

  • ends-with : Ends with.

  • regex : Regular expression.

  • starts-with : Starts with.

Usage Guidelines

Use this command to define rule expressions to match value in HTTP Host request-header field.

Example

The following command defines a rule expression to match "host1" in HTTP Host request-header field:
http host = host1 

active-charging service ruledef http referer

Configures rule expression to match the value in the HTTP Referer request-header field.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

http referer [ case-sensitive ] operator referer_name 

case-sensitive

Specify the rule expression must be case-sensitive. By default, rule expressions are not case-sensitive.

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • !contains : Does not contain.

  • !ends-with : Does not end with.

  • !present : Not present.

  • !starts-with : Does not start with.

  • = : Equals.

  • contains : Contains.

  • ends-with : Ends with.

  • regex : Regular expression.

  • starts-with : Starts with.

referer_name

Specify the HTTP referer name to match.

Must be a string of 1-127 characters.

Usage Guidelines

Use this command to define rule expressions to match value in HTTP Referer request-header field. This feature allows an operator to collect or track all URLs visited during a particular subscriber session. These URLs include the entire string of visited URLs, including all referral links. This information is output in an Event Data Record (EDR) format to support reporting or billing functions.

Example

The following command defines a rule expression to match the HTTP referer "cricket.espn.com":
http referer = cricket.espn.com 

active-charging service ruledef http url

Configures rule expression to match HTTP URL.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

http url [ case-sensitive ] operator url 

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • !contains : Does not contain.

  • !ends-with : Does not end with.

  • !present : Does not present.

  • !starts-with : Does not start with.

  • = : Equals.

  • case-sensitive : Is case sensitive.

  • contains : Contains.

  • ends-with : Ends with.

  • regex : Regular expression.

  • starts-with : Starts with.

url

Specify the HTTP URL to match.

Must be a string of 1-127 characters.

Usage Guidelines

Use this command to define rule expressions to match HTTP URL.

active-charging service ruledef http user-agent

Configures rule expressions to match the User-Agent.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

http user-agent [ case-sensitive ] operator user_agent_value 

case-sensitive

Specify the rule expression must be case-sensitive. By default, rule expressions are not case-sensitive.

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • !contains : Does not contain.

  • !ends-with : Does not end with.

  • !present : Not present.

  • !starts-with : Does not start with.

  • = : Equal.

  • contains : Contains.

  • ends-with : Ends with.

  • present : Present.

  • regex : Regular expression.

  • starts-with : Starts with.

user_agent_value

Specify the HTTP user agent value to match.

Must be a string of 1-127 characters.

Usage Guidelines

Use this command to configure rule expressions to match user agent.

active-charging service ruledef icmpv6 any-match

Configures rule expression to match all packets of the specified protocol.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

dns any-match operator condition 

Syntax

icmpv6 any-match operator condition 

Syntax

rtp any-match operator condition 

Syntax

rtsp any-match operator condition 

Syntax

secure-http any-match operator condition 

Syntax

tcp any-match operator condition 

Syntax

udp any-match operator condition 

Syntax

wsp any-match operator condition 

Syntax

wtp any-match operator condition 

condition

Specify the condition.

Must be one of the following:

  • FALSE

  • TRUE

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • = : Equals.

Usage Guidelines

Use this command to configure rule expression to match all packets of a specified protocol.

Example

The following command defines a rule expression to match all RTP packets:
rtp any-match = TRUE 

active-charging service ruledef ip any-match

Configures rule expressions to match all IPv4/IPv6 packets.

Syntax

ip any-match operator condition 

condition

Specify the condition.

Must be one of the following:

  • FALSE

  • TRUE

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • = : Equals.

Usage Guidelines

Use this command to define rule expressions to match IPv4/IPv6 packets.

Example

The following command defines a rule expression to match IPv4/IPv6 packets:
ip any-match = TRUE 

active-charging service ruledef ip dst-address

Configures rule expressions to match IP destination address field within IP headers.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

ip dst-address operator { ip_address | ip_prefix_length | address-group ipv6_address | host-pool host_pool_name } 

address-group ipv6_address_group_name

Specify a group of IPv6 addresses configured with wildcard input and/or specialized range input. Input is accepted as a string and parsed. Multiple wildcard characters can be accepted as input and only one 2-byte range input will be accepted. Both wildcard character input and 2-byte range input can be configured together within an IPv6 address. For example, 2607:7700:*:[2020-3040]::ce1d:b083/128. * is a wildcard input. [2020-3040] is a 2-byte specialized range input.

Must be a string of 1-56 characters.

host-pool host_pool_name

Specify name of the host pool.

Must be a string of 1-63 characters.

ip-address-prefix prefix

Specify the IP address prefix.

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

-Or-

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

-Or-

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

-Or-

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

ip_address

Specify the destination IP address.

Must be one of the following:

  • dst-address : DST address.

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • !range : Not in the range.

  • >= : Greater than or equal to.

  • <= : Lesser than or equal to.

  • = : Equals.

  • range : In the range.

Usage Guidelines

Use this command to define rule expressions to match the IP destination address field within IP headers.

Example

The following command defines a rule expression to match user traffic based on the IPv4 destination address 10.1.1.1:
ip dst-address = 10.1.1.1 

active-charging service ruledef ip protocol

Configures rule expression to match based on protocol being transported by IP packet.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

ip protocol operator protocol 

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • >= : Greater than or equal to.

  • <= : Lesser than or equal to.

  • = : Equals.

protocol

Specify the protocol.

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

-Or-

Must be one of the following:

  • ah

  • esp

  • gre

  • icmp

  • icmpv6

  • tcp

  • udp

Usage Guidelines

Use this command to define rule expressions to match based on protocol being transported by IP packet.

active-charging service ruledef ip server-ip-addr

Configure the server's IP address.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

ip server-ip-address operator { { { ipv4_address | ipv6_address } ip-address-prefix prefix | address-group ipv6_address_group_name } | host-pool host_pool_name } 

address-group ipv6_address_group_name

Specify a group of IPv6 addresses configured with wildcard input and/or specialized range input. Input is accepted as a string and parsed. Multiple wildcard characters can be accepted as input and only one 2-byte range input will be accepted. Both wildcard character input and 2-byte range input can be configured together within an IPv6 address. For example, 2607:7700:*:[2020-3040]::ce1d:b083/128. * is a wildcard input. [2020-3040] is a 2-byte specialized range input.

Must be a string of 1-56 characters.

host-pool host_pool_name

Specify name of the host pool.

Must be a string of 1-63 characters.

ip-address-prefix prefix

Specify the IP address prefix.

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

-Or-

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

-Or-

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

-Or-

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

{ ipv4_address | ipv6_address }

Specify IP address of the server.

Must be one of the following:

  • server-ip-address : server-ip-address.

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • !range : Not in the range.

  • >= : Greater than or equal to.

  • <= : Lesser than or equal to.

  • = : Equals.

  • range : In the range.

Usage Guidelines

Use this command to configure the server's IP address.

active-charging service ruledef ip uplink

Configures rule expression to match IP uplink packets.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

ip uplink operator condition 

condition

Specify the condition to match.

Must be one of the following:

  • FALSE : Not analyzed.

  • TRUE : Analyzed.

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • = : Equals.

Usage Guidelines

Use this command to configure matching IP uplink packets based on condition.

active-charging service ruledef ip version

Configures rule expression to match based on IP version.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

ip version operator ip_version 

ip_version

Specify the condition to match.

Must be one of the following:

  • ipv4

  • ipv6

operator

Specify how to match.

Must be one of the following:

  • = : Equals.

Usage Guidelines

Use this command to configure rule expression to match based on the IP version.

active-charging service ruledef multi-line-or

This command applies the OR operator to all lines in the current ruledef.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

multi-line-or all-lines 

all-lines

Applies the OR operator to all lines in the current ruledef.

Usage Guidelines

When a ruledef is evaluated, if the multi-line-or all-lines command is configured, the logical OR operator is applied to all the rule expressions in the ruledef to decide if the ruledef matches or not. If the multi-line-or all-lines command is not configured, the logical AND operator is applied to all the rule expressions.

active-charging service ruledef p2p

This command allows you to define rule expressions to match P2P protocol. This command must be used for charging purposes. It must not be used for detection purposes.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

p2p set-app-proto app_protocol_name 

p2p set-app-proto app_protocol_name

Specify name of the custom-defined protocol (CDP). CDP name specifies the name of the custom defined protocol (CDP) for TLS/SSL flows, QUIC flows or any app-identifier matching the ruledef. If the flow/packet matches the rule, the CDP name specified in the ruledef will be taken and the flow will be marked as CDP. If no CDP is configured in the rule, then the flow will be treated as TLS/SSL or QUIC flow.

Must be a string of 1-19 characters.

Usage Guidelines

Use this command to define rule expressions to detect P2P protocols for charging purposes. For detection purposes use the "p2p-detection protocol" command in the ACS Configuration Mode.

active-charging service ruledef p2p app-identifier

Configures application identifiers populated from the plugin and mark the matching flows to a custom-defined protocol (CDP) name.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

p2p app-identifier app_type operator app_identifier 

app_identifier

Specify the app identifier.

Must be a string of 1-127 characters.

app_type

Specify the application type.

Must be one of the following:

  • quic-sni : Specify the QUIC Server Name Indication (SNI) field value.

  • tls-cname : Specify the common name in the Server Hello message of TLS. SSL renegotiation is supported for the flows that are marked using "tls-cname" rules.

  • tls-sni : Specify the TLS/SSL Server Name Indication (SNI) field.

operator

Specify how to match.

Must be one of the following:

  • != : Not equals.

  • = : Equals.

  • contains : Contains.

  • ends-with : Ends with.

  • starts-with : Starts with.

Usage Guidelines

Use this command to configure application identifiers populated from the plugin and mark the matching flows to a custom-defined protocol (CDP) name. The SNI ruledef supports multi-line-or all-lines or default multi-line-and rule lines. The rule lines configured with "!=" operator will not be optimized.

Example

The following command configures the QUIC SNI app-identifier that is set to fb.com:
p2p app-identifier quic-sni = fb.com 

active-charging service ruledef p2p protocol

Configures the protocol to match parameter.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

p2p protocol operator p2p_protocol 

operator

Specify how to match.

Must be one of the following:

  • = : Equals.

p2p_protocol

Specify the P2P protocol.

Must be one of the following:

  • 8tracks : P2P detection protocol for "8tracks" application.

  • actionvoip : P2P detection protocol for "actionvoip" application.

  • actsync : P2P detection protocol for "actsync" application.

  • adobeconnect : P2P detection protocol for "adobeconnect" application.

  • aimini : P2P detection protocol for "aimini" application.

  • amazoncloud : P2P detection protocol for "amazoncloud" application.

  • amazonmusic : P2P detection protocol for "amazonmusic" application.

  • amazonvideo : P2P detection protocol for "amazonvideo" application.

  • antsp2p : P2P detection protocol for "antsp2p" application.

  • apple-push : P2P detection protocol for "apple-push" application.

  • apple-store : P2P detection protocol for "apple-store" application.

  • applejuice : P2P detection protocol for "applejuice" application.

  • applemaps : P2P detection protocol for "applemaps" application.

  • ares : P2P detection protocol for "ares" application.

  • armagettron : P2P detection protocol for "armagettron" application.

  • avi : P2P detection protocol for "avi" application.

  • badoo : P2P detection protocol for "badoo" application.

  • baidumovie : P2P detection protocol for "baidumovie" application.

  • battlefld : P2P detection protocol for "battlefld" application.

  • bbm : P2P detection protocol for "bbm" application.

  • beatport : P2P detection protocol for "beatport" application.

  • bitcasa : P2P detection protocol for "bitcasa" application.

  • bittorrent-sync : P2P detection protocol for "bittorrent-sync" application.

  • bittorrent : P2P detection protocol for "bittorrent" application.

  • blackberry-store : P2P detection protocol for "blackberry-store" application.

  • blackberry : P2P detection protocol for "blackberry" application.

  • blackdialer : P2P detection protocol for "blackdialer" application.

  • box : P2P detection protocol for "box" application.

  • callofduty : P2P detection protocol for "callofduty" application.

  • chikka : P2P detection protocol for "chikka" application.

  • cisco-jabber : P2P detection protocol for "cisco-jabber" application.

  • citrix : P2P detection protocol for "citrix" application.

  • clubbox : P2P detection protocol for "clubbox" application.

  • clubpenguin : P2P detection protocol for "clubpenguin" application.

  • comodounite : P2P detection protocol for "comodounite" application.

  • crackle : P2P detection protocol for "crackle" application.

  • crossfire : P2P detection protocol for "crossfire" application.

  • curiosity-stream : P2P detection protocol for "curiosity-stream" application.

  • cyberghost : P2P detection protocol for "cyberghost" application.

  • ddlink : P2P detection protocol for "ddlink" application.

  • didi : P2P detection protocol for "didi" application.

  • directconnect : P2P detection protocol for "directconnect" application.

  • dish-anywhere : P2P detection protocol for "dish-anywhere" application.

  • dns-tunneling : P2P detection protocol for "dns-tunneling" application.

  • dofus : P2P detection protocol for "dofus" application.

  • dropbox : P2P detection protocol for "dropbox" application.

  • ebuddy : P2P detection protocol for "ebuddy" application.

  • edonkey : P2P detection protocol for "edonkey" application.

  • espn : P2P detection protocol for "espn" application.

  • facebook : P2P detection protocol for "facebook" application.

  • facetime : P2P detection protocol for "facetime" application.

  • fandor : P2P detection protocol for "fandor" application.

  • fasttrack : P2P detection protocol for "fasttrack" application.

  • feidian : P2P detection protocol for "feidian" application.

  • ficall : P2P detection protocol for "ficall" application.

  • fiesta : P2P detection protocol for "fiesta" application.

  • filetopia : P2P detection protocol for "filetopia" application.

  • flash : P2P detection protocol for "flash" application.

  • flickr : P2P detection protocol for "flickr" application.

  • florensia : P2P detection protocol for "florensia" application.

  • foursquare : P2P detection protocol for "foursquare" application.

  • fox-sports : P2P detection protocol for "fox-sports" application.

  • freenet : P2P detection protocol for "freenet" application.

  • friendster : P2P detection protocol for "friendster" application.

  • fring : P2P detection protocol for "fring" application.

  • fubotv : P2P detection protocol for "fubotv" application.

  • funshion : P2P detection protocol for "funshion" application.

  • gadugadu : P2P detection protocol for "gadugadu" application.

  • gamekit : P2P detection protocol for "gamekit" application.

  • gmail : P2P detection protocol for "gmail" application.

  • gnutella : P2P detection protocol for "gnutella" application.

  • go90 : P2P detection protocol for "go90" application.

  • goober : P2P detection protocol for "goober" application.

  • google-music : P2P detection protocol for "google-music" application.

  • google-push : P2P detection protocol for "google-push" application.

  • google : P2P detection protocol for "google" application.

  • googleplay : P2P detection protocol for "googleplay" application.

  • googleplus : P2P detection protocol for "googleplus" application.

  • gotomeeting : P2P detection protocol for "gotomeeting" application.

  • gtalk : P2P detection protocol for "gtalk" application.

  • guildwars : P2P detection protocol for "guildwars" application.

  • halflife2 : P2P detection protocol for "halflife2" application.

  • hamachivpn : P2P detection protocol for "hamachivpn" application.

  • hbogo : P2P detection protocol for "hbogo" application.

  • hbonow : P2P detection protocol for "hbonow" application.

  • heytell : P2P detection protocol for "heytell" application.

  • hgtv : P2P detection protocol for "hgtv" application.

  • hike-messenger : P2P detection protocol for "hike-messenger" application.

  • hls : P2P detection protocol for "hls" application.

  • hotspotvpn : P2P detection protocol for "hotspotvpn" application.

  • http : P2P detection protocol for "http" application.

  • hulu : P2P detection protocol for "hulu" application.

  • hyves : P2P detection protocol for "hyves" application.

  • iax : P2P detection protocol for "iax" application.

  • icall : P2P detection protocol for "icall" application.

  • icecast : P2P detection protocol for "icecast" application.

  • icloud : P2P detection protocol for "icloud" application.

  • idrive : P2P detection protocol for "idrive" application.

  • igo : P2P detection protocol for "igo" application.

  • iheartradio : P2P detection protocol for "iheartradio" application.

  • imesh : P2P detection protocol for "imesh" application.

  • imessage : P2P detection protocol for "imessage" application.

  • imgur : P2P detection protocol for "imgur" application.

  • imo : P2P detection protocol for "imo" application.

  • implus : P2P detection protocol for "implus" application.

  • instagram : P2P detection protocol for "instagram" application.

  • iplayer : P2P detection protocol for "iplayer" application.

  • iptv : P2P detection protocol for "iptv" application.

  • irc : P2P detection protocol for "irc" application.

  • isakmp : P2P detection protocol for "isakmp" application.

  • iskoot : P2P detection protocol for "iskoot" application.

  • itunes : P2P detection protocol for "itunes" application.

  • jabber : P2P detection protocol for "jabber" application.

  • jap : P2P detection protocol for "jap" application.

  • jumblo : P2P detection protocol for "jumblo" application.

  • kakaotalk : P2P detection protocol for "kakaotalk" application.

  • kidoodle : P2P detection protocol for "kidoodle" application.

  • kik-messenger : P2P detection protocol for "kik-messenger" application.

  • kontiki : P2P detection protocol for "kontiki" application.

  • kugou : P2P detection protocol for "kugou" application.

  • kuro : P2P detection protocol for "kuro" application.

  • linkedin : P2P detection protocol for "linkedin" application.

  • lync : P2P detection protocol for "lync" application.

  • magicjack : P2P detection protocol for "magicjack" application.

  • manolito : P2P detection protocol for "manolito" application.

  • mapfactor : P2P detection protocol for "mapfactor" application.

  • mapi : P2P detection protocol for "mapi" application.

  • maplestory : P2P detection protocol for "maplestory" application.

  • meebo : P2P detection protocol for "meebo" application.

  • mega : P2P detection protocol for "mega" application.

  • mgcp : P2P detection protocol for "mgcp" application.

  • mig33 : P2P detection protocol for "mig33" application.

  • mlb : P2P detection protocol for "mlb" application.

  • mojo : P2P detection protocol for "mojo" application.

  • monkey3 : P2P detection protocol for "monkey3" application.

  • mozy : P2P detection protocol for "mozy" application.

  • msn : P2P detection protocol for "msn" application.

  • msrp : P2P detection protocol for "msrp" application.

  • mute : P2P detection protocol for "mute" application.

  • mypeople : P2P detection protocol for "mypeople" application.

  • myspace : P2P detection protocol for "myspace" application.

  • nateontalk : P2P detection protocol for "nateontalk" application.

  • naverline : P2P detection protocol for "naverline" application.

  • navigon : P2P detection protocol for "navigon" application.

  • nbc-sports : P2P detection protocol for "nbc-sports" application.

  • netflix : P2P detection protocol for "netflix" application.

  • netmotion : P2P detection protocol for "netmotion" application.

  • newsy : P2P detection protocol for "newsy" application.

  • nimbuzz : P2P detection protocol for "nimbuzz" application.

  • nokia-store : P2P detection protocol for "nokia-store" application.

  • octoshape : P2P detection protocol for "octoshape" application.

  • odnoklassniki : P2P detection protocol for "odnoklassniki" application.

  • off : P2P detection protocol for "off" application.

  • ogg : P2P detection protocol for "ogg" application.

  • oist : P2P detection protocol for "oist" application.

  • oovoo : P2P detection protocol for "oovoo" application.

  • opendrive : P2P detection protocol for "opendrive" application.

  • openft : P2P detection protocol for "openft" application.

  • openvpn : P2P detection protocol for "openvpn" application.

  • operamini : P2P detection protocol for "operamini" application.

  • orb : P2P detection protocol for "orb" application.

  • oscar : P2P detection protocol for "oscar" application.

  • outlook : P2P detection protocol for "outlook" application.

  • paltalk : P2P detection protocol for "paltalk" application.

  • pando : P2P detection protocol for "pando" application.

  • pandora : P2P detection protocol for "pandora" application.

  • path : P2P detection protocol for "path" application.

  • pcanywhere : P2P detection protocol for "pcanywhere" application.

  • periscope : P2P detection protocol for "periscope" application.

  • pinterest : P2P detection protocol for "pinterest" application.

  • plingm : P2P detection protocol for "plingm" application.

  • poco : P2P detection protocol for "poco" application.

  • popo : P2P detection protocol for "popo" application.

  • pplive : P2P detection protocol for "pplive" application.

  • ppstream : P2P detection protocol for "ppstream" application.

  • ps3 : P2P detection protocol for "ps3" application.

  • qq : P2P detection protocol for "qq" application.

  • qqgame : P2P detection protocol for "qqgame" application.

  • qqlive : P2P detection protocol for "qqlive" application.

  • quake : P2P detection protocol for "quake" application.

  • quic : P2P detection protocol for "quic" application.

  • quicktime : P2P detection protocol for "quicktime" application.

  • radio-paradise : P2P detection protocol for "radio-paradise" application.

  • rdp : P2P detection protocol for "rdp" application.

  • rdt : P2P detection protocol for "rdt" application.

  • regram : P2P detection protocol for "regram" application.

  • rfactor : P2P detection protocol for "rfactor" application.

  • rhapsody : P2P detection protocol for "rhapsody" application.

  • rmstream : P2P detection protocol for "rmstream" application.

  • rodi : P2P detection protocol for "rodi" application.

  • rynga : P2P detection protocol for "rynga" application.

  • samsung-store : P2P detection protocol for "samsung-store" application.

  • scydo : P2P detection protocol for "scydo" application.

  • secondlife : P2P detection protocol for "secondlife" application.

  • shoutcast : P2P detection protocol for "shoutcast" application.

  • showtime : P2P detection protocol for "showtime" application.

  • silverlight : P2P detection protocol for "silverlight" application.

  • siri : P2P detection protocol for "siri" application.

  • skinny : P2P detection protocol for "skinny" application.

  • skydrive : P2P detection protocol for "skydrive" application.

  • skype : P2P detection protocol for "Skype" application.

  • slacker-radio : P2P detection protocol for "slacker-radio" application.

  • slingbox : P2P detection protocol for "slingbox" application.

  • slingtv : P2P detection protocol for "slingtv" application.

  • smartvoip : P2P detection protocol for "smartvoip" application.

  • snapchat : P2P detection protocol for "snapchat" application.

  • softether : P2P detection protocol for "softether" application.

  • sopcast : P2P detection protocol for "sopcast" application.

  • soribada : P2P detection protocol for "soribada" application.

  • soulseek : P2P detection protocol for "soulseek" application.

  • soundcloud : P2P detection protocol for "soundcloud" application.

  • spdy : P2P detection protocol for "spdy" application.

  • speedtest : P2P detection protocol for "speedtest" application.

  • splashfighter : P2P detection protocol for "splashfighter" application.

  • spotify : P2P detection protocol for "spotify" application.

  • ssdp : P2P detection protocol for "ssdp" application.

  • ssl : P2P detection protocol for "ssl" application.

  • starz : P2P detection protocol for "starz" application.

  • stealthnet : P2P detection protocol for "stealthnet" application.

  • steam : P2P detection protocol for "steam" application.

  • stun : P2P detection protocol for "stun" application.

  • sudaphone : P2P detection protocol for "sudaphone" application.

  • svtplay : P2P detection protocol for "svtplay" application.

  • tagged : P2P detection protocol for "tagged" application.

  • talkatone : P2P detection protocol for "talkatone" application.

  • tango : P2P detection protocol for "tango" application.

  • teamspeak : P2P detection protocol for "teamspeak" application.

  • teamviewer : P2P detection protocol for "teamviewer" application.

  • telegram : P2P detection protocol for "telegram" application.

  • thunder : P2P detection protocol for "thunder" application.

  • thunderhs : P2P detection protocol for "thunderhs" application.

  • tmo-tv : P2P detection protocol for "tmo-tv" application.

  • tor : P2P detection protocol for "tor" application.

  • truecaller : P2P detection protocol for "truecaller" application.

  • truphone : P2P detection protocol for "truphone" application.

  • tumblr : P2P detection protocol for "tumblr" application.

  • tunein-radio : P2P detection protocol for "tunein-radio" application.

  • tunnelvoice : P2P detection protocol for "tunnelvoice" application.

  • tvants : P2P detection protocol for "tvants" application.

  • tvuplayer : P2P detection protocol for "tvuplayer" application.

  • twitch : P2P detection protocol for "twitch" application.

  • twitter : P2P detection protocol for "twitter" application.

  • ultrabac : P2P detection protocol for "ultrabac" application.

  • ultrasurf : P2P detection protocol for "ultrasurf" application.

  • univision : P2P detection protocol for "univision" application.

  • upc-phone : P2P detection protocol for "upc-phone" application.

  • usenet : P2P detection protocol for "usenet" application.

  • ustream : P2P detection protocol for "ustream" application.

  • uusee : P2P detection protocol for "uusee" application.

  • vchat : P2P detection protocol for "vchat" application.

  • veohtv : P2P detection protocol for "veohtv" application.

  • vessel : P2P detection protocol for "vessel" application.

  • vevo : P2P detection protocol for "vevo" application.

  • viber : P2P detection protocol for "viber" application.

  • vine : P2P detection protocol for "vine" application.

  • voipdiscount : P2P detection protocol for "voipdiscount" application.

  • vopium : P2P detection protocol for "vopium" application.

  • voxer : P2P detection protocol for "voxer" application.

  • vpnx : P2P detection protocol for "vpnx" application.

  • vtok : P2P detection protocol for "vtok" application.

  • vtun : P2P detection protocol for "vtun" application.

  • vudu : P2P detection protocol for "vudu" application.

  • warcft3 : P2P detection protocol for "warcft3" application.

  • waze : P2P detection protocol for "waze" application.

  • webex : P2P detection protocol for "webex" application.

  • wechat : P2P detection protocol for "wechat" application.

  • weibo : P2P detection protocol for "weibo" application.

  • whatsapp : P2P detection protocol for "whatsapp" application.

  • wii : P2P detection protocol for "wii" application.

  • windows-azure : P2P detection protocol for "windows-azure" application.

  • windows-store : P2P detection protocol for "windows-store" application.

  • winmx : P2P detection protocol for "winmx" application.

  • winny : P2P detection protocol for "winny" application.

  • wmstream : P2P detection protocol for "wmstream" application.

  • wofkungfu : P2P detection protocol for "wofkungfu" application.

  • wofwarcraft : P2P detection protocol for "wofwarcraft" application.

  • wuala : P2P detection protocol for "wuala" application.

  • wwe : P2P detection protocol for "wwe" application.

  • xbox : P2P detection protocol for "xbox" application.

  • xdcc : P2P detection protocol for "xdcc" application.

  • xing : P2P detection protocol for "xing" application.

  • yahoo : P2P detection protocol for "yahoo" application.

  • yahoomail : P2P detection protocol for "yahoomail" application.

  • youku : P2P detection protocol for "youku" application.

  • yourfreetunnel : P2P detection protocol for "yourfreetunnel" application.

  • youtube : P2P detection protocol for "youtube" application.

  • zattoo : P2P detection protocol for "zattoo" application.

Usage Guidelines

Use this command to specify the protocol to match.

active-charging service ruledef p2p traffic-type

Configures rule expression to match the traffic type.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

p2p traffic-type operator traffic_type 

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • = : Equals.

traffic_type

Specify the traffic type to match.

Must be one of the following:

  • ads

  • audio

  • file-transfer

  • im

  • streaming-audio

  • streaming-video

  • tunnel

  • unclassified

  • video

  • voipout

Usage Guidelines

Use this command to configure the system to detect voice or non-voice P2P traffic. When the detection of a protocol is enabled then the detection of sub-type is enabled by default.

Example

The following command configures the system to detect video traffic:
p2p traffic-type = video 

active-charging service ruledef rtp any-match

Configures rule expression to match all packets of the specified protocol.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

dns any-match operator condition 

Syntax

icmpv6 any-match operator condition 

Syntax

rtp any-match operator condition 

Syntax

rtsp any-match operator condition 

Syntax

secure-http any-match operator condition 

Syntax

tcp any-match operator condition 

Syntax

udp any-match operator condition 

Syntax

wsp any-match operator condition 

Syntax

wtp any-match operator condition 

condition

Specify the condition.

Must be one of the following:

  • FALSE

  • TRUE

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • = : Equals.

Usage Guidelines

Use this command to configure rule expression to match all packets of a specified protocol.

Example

The following command defines a rule expression to match all RTP packets:
rtp any-match = TRUE 

active-charging service ruledef rtsp any-match

Configures rule expression to match all packets of the specified protocol.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

dns any-match operator condition 

Syntax

icmpv6 any-match operator condition 

Syntax

rtp any-match operator condition 

Syntax

rtsp any-match operator condition 

Syntax

secure-http any-match operator condition 

Syntax

tcp any-match operator condition 

Syntax

udp any-match operator condition 

Syntax

wsp any-match operator condition 

Syntax

wtp any-match operator condition 

condition

Specify the condition.

Must be one of the following:

  • FALSE

  • TRUE

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • = : Equals.

Usage Guidelines

Use this command to configure rule expression to match all packets of a specified protocol.

Example

The following command defines a rule expression to match all RTP packets:
rtp any-match = TRUE 

active-charging service ruledef secure-http any-match

Configures rule expression to match all packets of the specified protocol.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

dns any-match operator condition 

Syntax

icmpv6 any-match operator condition 

Syntax

rtp any-match operator condition 

Syntax

rtsp any-match operator condition 

Syntax

secure-http any-match operator condition 

Syntax

tcp any-match operator condition 

Syntax

udp any-match operator condition 

Syntax

wsp any-match operator condition 

Syntax

wtp any-match operator condition 

condition

Specify the condition.

Must be one of the following:

  • FALSE

  • TRUE

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • = : Equals.

Usage Guidelines

Use this command to configure rule expression to match all packets of a specified protocol.

Example

The following command defines a rule expression to match all RTP packets:
rtp any-match = TRUE 

active-charging service ruledef secure-http uplink

Configures rule expression to match HTTPS uplink (subscriber to network) packets.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

secure-http uplink operator condition 

condition

Specify the condition to match.

Must be one of the following:

  • FALSE

  • TRUE

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • = : Equals.

Usage Guidelines

Use this command to specify the HTTPS uplink packets.

active-charging service ruledef tcp any-match

Configures rule expression to match all packets of the specified protocol.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

dns any-match operator condition 

Syntax

icmpv6 any-match operator condition 

Syntax

rtp any-match operator condition 

Syntax

rtsp any-match operator condition 

Syntax

secure-http any-match operator condition 

Syntax

tcp any-match operator condition 

Syntax

udp any-match operator condition 

Syntax

wsp any-match operator condition 

Syntax

wtp any-match operator condition 

condition

Specify the condition.

Must be one of the following:

  • FALSE

  • TRUE

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • = : Equals.

Usage Guidelines

Use this command to configure rule expression to match all packets of a specified protocol.

Example

The following command defines a rule expression to match all RTP packets:
rtp any-match = TRUE 

active-charging service ruledef tcp either-port with-portMap-range

Configures port selection with port map range.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

tcp either-port operator port-map port_map_name 

Syntax

udp either-port operator port-map port_map_name 

port-map port_map_name

Specify name of the port map.

Must be a string of 1-63 characters.

operator

Specify how to match.

Must be one of the following:

  • !range : Not in the range of.

  • range : In the range of.

Usage Guidelines

Use this command to configure with port map range.

active-charging service ruledef tcp either-port with-range

Configures port configuration with range.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

tcp either-port operator start_range to end_range 

Syntax

udp either-port operator start_range to end_range 

to

Specify until node.

Must be one of the following:

  • to

end_range

Specify the end range.

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

operator

Specify how to match.

Must be one of the following:

  • !range : Not in the range of.

  • range : In the range of.

start_range

Specify the start range.

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

Usage Guidelines

Use this command to configure port configuration with range.

active-charging service ruledef tcp either-port without-range

Configures port configuration without range.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

tcp either-port operator port port_number 

Syntax

udp either-port operator port port_number 

port port_number

Specify the port number.

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

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • >= : Greater than or equal to.

  • <= : Lesser than or equal to.

  • = : Equals.

Usage Guidelines

Use this command to configure port configuration without range.

active-charging service ruledef tcp flag

Configures rule expression to match bit within the Flag field of TCP headers.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

tcp flag operator flag 

flag

Specify the flag to match.

Must be one of the following:

  • ack

  • fin

  • push

  • reset

  • sync

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • !contains : Does not contain.

  • = : Equals.

  • contains : Contains.

Usage Guidelines

Use this command to configure rule expression to match bit within the Flag field of TCP headers.

active-charging service ruledef tcp state

Configures rule expression to match current state of TCP connections.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

tcp state operator current_state 

current_state

Specify the state to match.

Must be one of the following:

  • close-wait

  • close

  • closing

  • established

  • fin-wait1

  • fin-wait2

  • last-ack

  • listen

  • syn-received

  • syn-sent

  • time-wait

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • = : Equals.

Usage Guidelines

Use this command to define rule expressions to match a current state of TCP connections.

Example

The following command defines a rule expression to match user traffic based on current state "close":
tcp state = close 

active-charging service ruledef tethering-detection

Configures rule expression to match tethered or non-tethered flows.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

tethering-detection flow_option 

flow_option

Specify the flow option.

Must be one of the following:

  • flow-not-tethered : If tethering is not detected on flow.

  • flow-tethered : If tethering is detected on flow.

Usage Guidelines

Use this command to define rule expressions to match tethered/non-tethered flows. Note that in order for the rule containing the tethering-detection configuration to get matched, at least one valid rule line has to be present in it.

Example

The following command defines a rule expression to match tethered flows:
tethering-detection flow-tethered 

active-charging service ruledef tethering-detection application

Configures application-based tethering detection.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

tethering-detection application flow_option 

flow_option

Specify the flow option.

Must be one of the following:

  • flow-not-tethered : If tethering is not detected on flow.

  • flow-tethered : If tethering is detected on flow.

Usage Guidelines

Use this command to select flows that were tethered or non-tethered based on application-based detection solution.

active-charging service ruledef tethering-detection dns-based

Configures DNS query pattern based tethering detection.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

tethering-detection dns-based flow_option 

flow_option

Specify the flow option.

Must be one of the following:

  • flow-not-tethered : If tethering is not detected on flow.

  • flow-tethered : If tethering is detected on flow.

Usage Guidelines

Use this command to select flows that were tethered or non-tethered based on DNS-based detection solution.

active-charging service ruledef tethering-detection ip-ttl

Configures IP-TTL based tethering detection.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

tethering-detection ip-ttl flow_option 

flow_option

Specify the flow option.

Must be one of the following:

  • flow-not-tethered : If tethering is not detected on flow.

  • flow-tethered : If tethering is detected on flow.

Usage Guidelines

Use this command to select flows that were tethered or non-tethered as per IP-TTL values.

active-charging service ruledef tethering-detection os-ua

Configures OS-UA based tethering detection.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

tethering-detection os-ua flow_option 

flow_option

Specify the flow option.

Must be one of the following:

  • flow-not-tethered : If tethering is not detected on flow.

  • flow-tethered : If tethering is detected on flow.

Usage Guidelines

Use this command to select flows that were tethered or non-tethered as per OS-UA lookups.

active-charging service ruledef udp any-match

Configures rule expression to match all packets of the specified protocol.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

dns any-match operator condition 

Syntax

icmpv6 any-match operator condition 

Syntax

rtp any-match operator condition 

Syntax

rtsp any-match operator condition 

Syntax

secure-http any-match operator condition 

Syntax

tcp any-match operator condition 

Syntax

udp any-match operator condition 

Syntax

wsp any-match operator condition 

Syntax

wtp any-match operator condition 

condition

Specify the condition.

Must be one of the following:

  • FALSE

  • TRUE

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • = : Equals.

Usage Guidelines

Use this command to configure rule expression to match all packets of a specified protocol.

Example

The following command defines a rule expression to match all RTP packets:
rtp any-match = TRUE 

active-charging service ruledef udp either-port with-portMap-range

Configures port selection with port map range.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

tcp either-port operator port-map port_map_name 

Syntax

udp either-port operator port-map port_map_name 

port-map port_map_name

Specify name of the port map.

Must be a string of 1-63 characters.

operator

Specify how to match.

Must be one of the following:

  • !range : Not in the range of.

  • range : In the range of.

Usage Guidelines

Use this command to configure with port map range.

active-charging service ruledef udp either-port with-range

Configures port configuration with range.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

tcp either-port operator start_range to end_range 

Syntax

udp either-port operator start_range to end_range 

to

Specify until node.

Must be one of the following:

  • to

end_range

Specify the end range.

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

operator

Specify how to match.

Must be one of the following:

  • !range : Not in the range of.

  • range : In the range of.

start_range

Specify the start range.

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

Usage Guidelines

Use this command to configure port configuration with range.

active-charging service ruledef udp either-port without-range

Configures port configuration without range.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

tcp either-port operator port port_number 

Syntax

udp either-port operator port port_number 

port port_number

Specify the port number.

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

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • >= : Greater than or equal to.

  • <= : Lesser than or equal to.

  • = : Equals.

Usage Guidelines

Use this command to configure port configuration without range.

active-charging service ruledef wsp any-match

Configures rule expression to match all packets of the specified protocol.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

dns any-match operator condition 

Syntax

icmpv6 any-match operator condition 

Syntax

rtp any-match operator condition 

Syntax

rtsp any-match operator condition 

Syntax

secure-http any-match operator condition 

Syntax

tcp any-match operator condition 

Syntax

udp any-match operator condition 

Syntax

wsp any-match operator condition 

Syntax

wtp any-match operator condition 

condition

Specify the condition.

Must be one of the following:

  • FALSE

  • TRUE

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • = : Equals.

Usage Guidelines

Use this command to configure rule expression to match all packets of a specified protocol.

Example

The following command defines a rule expression to match all RTP packets:
rtp any-match = TRUE 

active-charging service ruledef wtp any-match

Configures rule expression to match all packets of the specified protocol.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

dns any-match operator condition 

Syntax

icmpv6 any-match operator condition 

Syntax

rtp any-match operator condition 

Syntax

rtsp any-match operator condition 

Syntax

secure-http any-match operator condition 

Syntax

tcp any-match operator condition 

Syntax

udp any-match operator condition 

Syntax

wsp any-match operator condition 

Syntax

wtp any-match operator condition 

condition

Specify the condition.

Must be one of the following:

  • FALSE

  • TRUE

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • = : Equals.

Usage Guidelines

Use this command to configure rule expression to match all packets of a specified protocol.

Example

The following command defines a rule expression to match all RTP packets:
rtp any-match = TRUE 

active-charging service ruledef www any-match

Configures rule expression to match all WWW packets. It is true for HTTP, WAP1.x, and WAP2.0 protocols.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

www any-match operator condition 

condition

Specify the condition to match.

Must be one of the following:

  • FALSE

  • TRUE

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • = : Equals.

Usage Guidelines

Use this command to define rule expressions to match all WWW packets. This expression is true for HTTP, WAP1.x, and WAP2.0 protocols

Example

The following command defines a rule expression to match all WWW packets:
www any-match = TRUE 

active-charging service ruledef www host

Configures rule expression to match the "host name" header field present in HTTP/WSP headers.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

www host [ case-sensitive ] operator host_name 

case-sensitive

Specify the rule expression must be case-sensitive. By default, rule expressions are not case-sensitive.

host_name

Specify the WWW host name to match.

Must be a string of 1-127 characters.

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • !contains : Does not contain.

  • !ends-with : Does not end with.

  • !starts-with : Does not start with.

  • = : Equals.

  • contains : Contains.

  • ends-with : Ends with.

  • regex : Regular expression.

  • starts-with : Starts with.

Usage Guidelines

Use this command to define rule expressions to match the host name header field present in HTTP/WSP headers.

Example

The following command defines a rule expression to match user traffic based on WWW host name "host1":
www host = host1 

active-charging service ruledef www url

Configures rule expressions to match URL.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > Ruledef Configuration (config-ruledef-ruledef_name )

Syntax

www url [ case-sensitive ] operator url 

case-sensitive

Specify the rule expression must be case-sensitive. By default, rule expressions are not case-sensitive.

operator

Specify how to match.

Must be one of the following:

  • != : Does not equal.

  • !contains : Does not contain.

  • !ends-with : Does not end with.

  • !starts-with : Does not start with.

  • = : Equals.

  • contains : Contains.

  • ends-with : Ends with.

  • regex : Regular expression.

  • starts-with : Starts with.

url

Specify the URL to match.

Must be a string of 1-127 characters.

Usage Guidelines

Use this command to configure the rule expressions to match URLsfor any Web protocol analyzer HTTP, WAP1.X, WAP2.0.

active-charging service url-blacklisting

Enable URL Blacklisting functionality.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name )

Syntax

url-blacklisting match-method match_method 

match-method match_method

Specify the match method to look up for URLs in the URL Blacklisting database.

Must be one of the following:

  • exact : URL Blacklisting is performed only on exact match with a URL present in the URL.

  • generic : URL Blacklisting is performed on a generic match with URLs present in the URL Blacklisting database.

Default Value: exact.

Usage Guidelines

Use this command to enable URL Blacklisting functionality.

active-charging service urr-list

Configures ACS URR List configuration.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name )

Syntax

urr-list urr_list_name 

urr_list_name

Specify name of the URR list.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to configure the ACS URR List configuration. Enters the URR List Configuration mode (config-urr-list-<urr_list_name>). This mode allows mapping of URR-ID with Rating Group and Service-ID.

You can configure a maximum of one element with this command.

active-charging service urr-list urr-list-data

Configures URR list data.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > URR List Configuration (config-urr-list-urr_list_name )

Syntax

rating-group rating_id urr-id urr_id 

rating group rating_id

Specify the rating ID used in prepaid charging.

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

urr-id urr_id

Specify the URR identifier for rating/service group.

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

Usage Guidelines

Use this command to configure the URR list data.

active-charging service urr-list urr-list-data service-identifier

Configures the URR ID service identifier parameter.

Command Mode

Exec > Global Configuration (config) > ACS Configuration (config-service-acs_name ) > URR List Configuration (config-urr-list-urr_list_name )

Syntax

rating-group rating_id urr-id urr_id service-identifier service_id urr-id urr_id 

service-identifier service_id

Specify the service ID, the number given to the service.

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

urr-id urr_id

Specify the URR identifier for rating/service group.

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

Usage Guidelines

Use this command to configure the URR ID service identifier parameter.

apn

Configures Access Point Name (APN) templates.

Command Mode

Exec > Global Configuration (config)

Syntax

apn apn_name 

apn apn_name

Specify name of the APN.

Must be a string in the pattern '[A-Za-z0-9]{1}[A-za-z0-9.-]{1,61}'.

Usage Guidelines

Use this command to create and configure an APN.

Example

The following command creates an APN template named isp1:
apn isp1 

apn active-charging

Enables a configured ACS rulebase.

Command Mode

Exec > Global Configuration (config) > APN Configuration (config-apn-apn_name )

Syntax

active-charging rulebase rulebase_name 

rulebase rulebase_name

Specify name of the rulebase.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to enable a configured ACS rulebase.

apn authorize-with-hss

Configures S6b authentication.

Command Mode

Exec > Global Configuration (config) > APN Configuration (config-apn-apn_name )

Syntax

authorize-with-hss [ report-ipv6-addr ] 

report-ipv6-addr

Specify to enable IPv6 reporting through AAR towards S6b interface.

Usage Guidelines

Use this command to configure S6b authentication. Enables IPv6 reporting through AAR towards S6b interface.

apn authorize-with-hss egtp

Enables S6b authorization for all the interfaces of EGTP along with GN-GP Handover except 3G initial attach.

Command Mode

Exec > Global Configuration (config) > APN Configuration (config-apn-apn_name )

Syntax

authorize-with-hss egtp [ report-ipv6-addr ] 

report-ipv6-addr

Specify to enable IPv6 reporting through AAR towards S6b interface.

Usage Guidelines

Use this command to enable S6b authorization for all the interfaces of EGTP along with GN-GP Handover except 3G initial attach.

apn authorize-with-hss egtp gn-gp-enabled

Enables S6b authorization for 3G Initial Attach and GnGp Handover.

Command Mode

Exec > Global Configuration (config) > APN Configuration (config-apn-apn_name )

Syntax

authorize-with-hss egtp gn-gp-enabled report-ipv6-addr 

report-ipv6-addr

Specify to enable IPv6 reporting through AAR towards S6b interface.

Usage Guidelines

Use this command to enable S6b authorization for 3G Initial Attach and GnGp Handover.

apn authorize-with-hss egtp s2b

Enables S6b authorization for egtp-s2b.

Command Mode

Exec > Global Configuration (config) > APN Configuration (config-apn-apn_name )

Syntax

authorize-with-hss egtp s2b report-ipv6-addr 

report-ipv6-addr

Specify to enable IPv6 reporting through AAR towards S6b interface.

Usage Guidelines

Use this command to enable S6b authorization for egtp-s2b.

apn authorize-with-hss egtp s2b gn-gp-enabled

Enables S6b authorization for 3G Initial Attach and GnGp Handover.

Command Mode

Exec > Global Configuration (config) > APN Configuration (config-apn-apn_name )

Syntax

authorize-with-hss egtp s2b gn-gp-enabled report-ipv6-addr 

report-ipv6-addr

Specify to enable IPv6 reporting through AAR towards S6b interface.

Usage Guidelines

Use this command to enable S6b authorization for 3G Initial Attach and GnGp Handover.

apn authorize-with-hss egtp s2b s5-s8

Enables S6b authorization for egtp-s5s8.

Command Mode

Exec > Global Configuration (config) > APN Configuration (config-apn-apn_name )

Syntax

authorize-with-hss egtp s2b s5-s8 [ gn_gp_option | report-ipv6-addr ] 

report-ipv6-addr

Specify to enable IPv6 reporting through AAR towards s6b interface.

gn_gp_option

Specify to enable or disable S6b authorization for 3G Initial Attach and GnGp Handover.

Must be one of the following:

  • gn-gp-disabled : Disables S6b authorization for 3G Initial Attach and GnGp Handover.

  • gn-gp-enabled : Enables S6b authorization for 3G Initial Attach and GnGp Handover.

Usage Guidelines

Use this command to enable S6b authorization for egtp-s5s8.

apn authorize-with-hss egtp s5-s8

Enables S6b authorization for egtp-s5s8.

Command Mode

Exec > Global Configuration (config) > APN Configuration (config-apn-apn_name )

Syntax

authorize-with-hss egtp s5-s8 [ gn_gp_option ] [ report-ipv6-addr ] 

report-ipv6-addr

Specify to enable IPv6 reporting through AAR towards s6b interface.

gn_gp_option

Specify to enable or disable S6b authorization for 3G Initial Attach and GnGp Handover.

Must be one of the following:

  • gn-gp-disabled : Disables S6b authorization for 3G Initial Attach and GnGp Handover.

  • gn-gp-enabled : Enables S6b authorization for 3G Initial Attach and GnGp Handover.

Usage Guidelines

Use this command to enable S6b authorization for egtp-s5s8.

apn authorize-with-hss egtp s5-s8 s2b

Enables S6b authorization for egtp-s2b.

Command Mode

Exec > Global Configuration (config) > APN Configuration (config-apn-apn_name )

Syntax

authorize-with-hss egtp s5-s8 s2b [ gn_gp_option ] [ report-ipv6-addr ] 

report-ipv6-addr

Specify to enable IPv6 reporting through AAR towards s6b interface.

gn_gp_option

Specify to enable or disable S6b authorization for 3G Initial Attach and GnGp Handover.

Must be one of the following:

  • gn-gp-disabled : Disables S6b authorization for 3G Initial Attach and GnGp Handover.

  • gn-gp-enabled : Enables S6b authorization for 3G Initial Attach and GnGp Handover.

Usage Guidelines

Use this command to enable S6b authorization for egtp-s2b.

apn authorize-with-hss lma

Enables IPv6 reporting through AAR towards S6b.

Command Mode

Exec > Global Configuration (config) > APN Configuration (config-apn-apn_name )

Syntax

authorize-with-hss lma [ report-ipv6-addr | s6b-aaa-group group_name ] 

report-ipv6-addr

Specify to enable IPv6 reporting through AAR towards S6b interface.

s6b-aaa-group group_name

Specify the AAA group name for S6b authorization.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to enable IPv6 reporting through AAR towards S6b.

apn cc-profile

Configures the subscriber charging characteristics profile parameters.

Command Mode

Exec > Global Configuration (config) > APN Configuration (config-apn-apn_name )

Syntax

cc-profile index { credit-control-group cc_group_name | prepaid-prohibited } 

cc-profile index

Specify the charging characterstics profile index.

Must be an integer.

-Or-

Must be one of the following:

  • any

credit-control-group cc_group_name

Specify name of the credit control group.

Must be a string of 1-63 characters.

prepaid-prohibited

Specify to disable prepaid for the configured profile index.

Usage Guidelines

Use this command to configure the subscriber charging characteristics profile parameters.

apn content-filtering category

Configures Content Filtering category.

Command Mode

Exec > Global Configuration (config) > APN Configuration (config-apn-apn_name )

Syntax

content-filtering category policy-id policy_id 

policy-id policy_id

Specify the Content Filtering Policy ID.

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

Usage Guidelines

Use this command to configure Content Filtering category.

apn data-tunnel

Configures the data tunnel MTU parameter.

Command Mode

Exec > Global Configuration (config) > APN Configuration (config-apn-apn_name )

Syntax

data-tunnel mtu max_transmission_unit 

mtu max_transmission_unit

Specify the data tunnel MTU value, in octets.

Must be an integer.

Usage Guidelines

Use this command to configure the data tunnel MTU parameter.

apn gtpp group

Enables and configures the GTPP group to be used by this APN.

Command Mode

Exec > Global Configuration (config) > APN Configuration (config-apn-apn_name )

Syntax

gtpp group gtpp_group_name 

group gtpp_group_name

Specify name of the GTPP group.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to enable and configure the GTPP group to be used by this APN.

apn ip access-group

Configures an IPv4/IPv6 access group for the current APN profile.

Command Mode

Exec > Global Configuration (config) > APN Configuration (config-apn-apn_name )

Syntax

ip access-group acl_group_name [ in | out ] 

access-group acl_group_name

Specify name of the IPv4/IPv6 access group.

Must be a string of 1-47 characters.

in

Specify the access group as inbound.

out

Specify the access group as outbound.

Usage Guidelines

Use this command to apply a single IPv4/IPv6 access control list to multiple subscribers via this APN for inbound or outbound IPv4/IPv6 traffic. If no traffic direction is specified, the selected access control list will be applied to both directions.

You can configure a maximum of eight elements with this command.

apn ip source-violation

Enables or disables packet source validation for the current APN.

Command Mode

Exec > Global Configuration (config) > APN Configuration (config-apn-apn_name )

Syntax

ip source-violation ignore 

ignore

Disables source address checking for the APN.

Usage Guidelines

Use this command to enable packet source validation. Source validation is useful if packet spoofing is suspected or for verifying packet routing and labeling within the network. Source validation requires the source address of received packets to match the IP address assigned to the subscriber (either statically or dynamically) during the session.

Example

The following command enables source address validation for the APN and configures a drop-limit of 15:
ip source-violation check drop-limit 15 

apn ppp

Configures PPP parameters for specified APN.

Command Mode

Exec > Global Configuration (config) > APN Configuration (config-apn-apn_name )

Syntax

ppp mtu max_transmission_unit 

mtu max_transmission_unit

Specify the maximum transmission unit. Default Value: 1500.

Must be an integer.

Usage Guidelines

Use this command to configure the PPP parameters for specified APN.

apn timeout

Configures session timeout parameters for the current APN.

Command Mode

Exec > Global Configuration (config) > APN Configuration (config-apn-apn_name )

Syntax

timeout idle idle_timeout 

idle idle_timeout

Specify the session idle timeout period for the current APN.

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

Usage Guidelines

Use this command to configure the session timeout parameters for the current APN.

cd

Configures the change directory command.

Privilege Level

Security Administrator, Administrator

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.

Privilege Level

Security Administrator, Administrator

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.

Privilege Level

Security Administrator, Administrator

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.

Privilege Level

Security Administrator, Administrator

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 IPAM operational data.

Command Mode

Exec

Syntax

clear ipam 

Usage Guidelines

Use this command to clear IPAM operational data.

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 lawful-intercept stats

Clears Lawful Interception IRI Send and IRI Drop counters.

Command Mode

Exec

Syntax

clear lawful-intercept stats 

Usage Guidelines

Use this command to clear Lawful Interception IRI Send and IRI Drop counters.

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.

imsi imsi

Specify the International Mobile Subscriber Identifier (IMSI).

Must be a string.

msid msid

Specify the Mobile Station Identifier (MSID).

Must be a string.

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.

clear subscriber supi-opt

Clears subscriber data based on SUPI.

Command Mode

Exec

Syntax

clear subscriber supi supi_id [ psid pdu_session_id | ebi eps_bearer_id | reactivation { false | true } } ] 

all

Specify to remove all subscriber data.

ebi eps_bearer_id

Specify the EPS Bearer ID.

Must be a string.

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.

imsi imsi

Specify the International Mobile Subscriber Identifier (IMSI).

Must be a string.

msid msid

Specify the Mobile Station Identifier (MSID).

Must be a string.

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.

psid pdu_session_id

Specify the PDU Session ID.

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

reactivation { false | true }

Specify if reactivation is requested.

Must be one of the following:

  • false

  • true

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.

Usage Guidelines

Use this command to clear subscriber data based on SUPI.

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.

clear subscriber imsi-opt

Clears subscriber data based on IMSI.

Command Mode

Exec

Syntax

clear subscriber imsi-options imsi_option [ ebi eps_bearer_id ] 

ebi eps_bearer_id

Specify the EPS Bearer ID.

Must be a string.

Usage Guidelines

Use this command to clear subscriber data based on IMSI.

clear subscriber supi-opt

Clears subscriber data based on SUPI.

Command Mode

Exec

Syntax

clear subscriber supi supi_id [ psid pdu_session_id | ebi eps_bearer_id | reactivation { false | true } } ] 

ebi eps_bearer_id

Specify the EPS Bearer ID.

Must be a string.

psid pdu_session_id

Specify the PDU Session ID.

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

reactivation { false | true }

Specify if reactivation is requested.

Must be one of the following:

  • false

  • true

clear ipam

Clears IPAM operational data.

Command Mode

Exec

Syntax

clear ipam 

clear lawful-intercept

Usage Guidelines

Use this command to clear subscriber data based on SUPI.

Usage Guidelines

Use this command to clear IPAM operational 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.


Note


Specify scp interface to detect a dead SCP.


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.

commit

Configures the commit parameters.

Privilege Level

Security Administrator, Administrator

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.

Privilege Level

Security Administrator, Administrator

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.

Privilege Level

Security Administrator, Administrator

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.

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.

describe

Displays the command information.

Privilege Level

Security Administrator, Administrator

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.

diagnostics info

Displays diagnostics information.

Command Mode

Exec

Syntax

show diagnostics [ info ] 

Usage Guidelines

Use this command to view diagnostics 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.

dump core

Enables and configures inconsistency checks on session data.

Command Mode

Exec > Global Configuration (config)

Syntax

dump core [ [ count max_core_count_per_interval ] [ expires expiration_time ] [ file-detail file_name_line_number ] [ interval interval_duration ] [ pod-name pod_names ] ] 

count max_core_count_per_interval

Specify the maximum number of times core can be generated in an interval.

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

expires expiration_time

Specify the time after which the core agent will stop core dump generation. For example, 2020-03-24T23:15:00+05:30.

Must be a string in the date-and-time pattern. For information on the date-and-time pattern, see the Input Pattern Types chapter.

file-detail file_name_line_number

Specify the file name and line number to specific core dump. For example, procedures/pduim/procedure.go:1902.

Must be a string.

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

interval interval_duration

Specify the duration of the interval in minutes.

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

pod-name pod_names

Specify the names of the pods to enable core dump.

Must be a string.

Usage Guidelines

Use this command to enable and configure inconsistency checks on session data.

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 ] [ all | subscribers subscribers_for_edr_reporting ] } 

reporting reporting_status

Specify to enable or disable EDR reporting.

Must be one of the following:

  • disable

  • enable

Default Value: disable.

reporting all

Specify to enable EDR reporting for all subscribers.

subscribers subscribers_for_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.


Note


The edr reporting all command takes precedence over the edr reporting subscribers command when enabled.


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 information.

Command Mode

Exec

Syntax

show endpoint [ all ] 

Usage Guidelines

Use this command to view endpoint status information.

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.

exit

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

Privilege Level

Security Administrator, Administrator

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.

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 replication-pull

geo replication-pull pulls the replication data from the peer rack and syncs it with the local rack.

Command Mode

Exec

Syntax

geo replication-pull instance-id gr_instanceId  

geo replication-pull

It pulls the replication data from the peer rack and syncs it with the local rack.

instance-id instance_id

Specify the instance ID for geo command.

Usage Guidelines

Use this command to pull the replication data from the peer rack and sync it with the local rack.

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

Geo switch-role switches the role to peer rack.

Command Mode

Exec

Syntax

geo switch-role  instance-id instance_id role new_role [ failback-interval failback_interval ] 

instance-id instance_id

Specify the instance ID for the geo command.

role new_role

Specify the new role for the specified site.

[ failback-interval failback_interval ]

The recommended value is 0.


Note


The CLI [ failback-interval ] is an optional command to provide backward compatibility of upgrades between releases. It is deprecated from the current release and will be discontinued from the subsequent releases.


Usage Guidelines

Use this command to switch the role to peer rack.

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 VIP monitoring parameters.

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.

group nf-mgmt

Configures NF management group name.

Command Mode

Exec > Global Configuration (config)

Syntax

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

failure-handling-profile fh_profile_name

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

Must be a string.

locality locality_name

Specify the locality information.

Must be a string.

nf-mgmt mgmt_group_name

Specify name of the NRF management group.

Must be a string.

nrf-mgmt-group nrf_mgmt_group_name

Specify name of the NRF management group.

Must be a string.

Usage Guidelines

Use this command to configure NF management group name.

group nf-mgmt heartbeat

Configures heartbeat interval.

Command Mode

Exec > Global Configuration (config)

Syntax

heartbeat interval heartbeat_interval 

interval heartbeat_interval

Specify the heartbeat interval in seconds.

Must be an integer.

Usage Guidelines

Use this command to configure the heartbeat interval.

group nrf discovery

Configures NRF discovery group parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

discovery group_name [ nrf-type nrf_type ] 

discovery group_name

Specify name of the NRF discovery group.

Must be a string.

nrf-type nrf_type

Specify the NRF type.

Must be one of the following:

  • PLMN : PLMN.

  • SHARED : SHARED.

  • SLICE-LOCAL : SLICE-LOCAL.

Usage Guidelines

Use this command to configure the NRF discovery group configuration.

group nrf discovery service type nrf

Configures the NRF discovery service name.

Command Mode

Exec > Global Configuration (config)

Syntax

nrf nrf_service_name [ responsetimeout response_timeout ] 

nrf nrf_service_name

Specify name of the NRF discovery service.

Must be one of the following:

  • nnrf-disc

responsetimeout response_timeout

Specify the response timeout interval in milliseconds.

Must be an integer.

Default Value: 2000.

Usage Guidelines

Use this command to configure the NRF discovery service name.

group nrf discovery service type nrf endpoint-profile

Configures endpoint profile parameters.

Command Mode

Exec > Global Configuration

Syntax

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

api-root api_root

Specify the API root.

Must be a string.

api-uri-prefix api_uri_prefix

Specify the API URI prefix.

Must be a string.

endpoint-profile endpoint_profile_name

Specify name of the endpoint profile.

Must be a string.

uri-scheme uri_scheme

Specify the URI scheme.

Must be one of the following:

  • http

  • https

Usage Guidelines

Use this command to configure endpoint profile parameters.

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

Configures endpoint parameters.

Command Mode

Exec > Global Configuration

Syntax

endpoint-name endpoint_name [ priority priority | capacity endpoint_capacity ] 

capacity endpoint_capacity

Specify the endpoint capacity.

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

Default Value: 10.

priority priority

Specify the node priority for endpoint.

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

endpoint_name

Specify name of the endpoint.

Must be a string.

Usage Guidelines

Use this command to configure endpoint parameters.

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

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

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

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

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

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

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

Configures URI version information.

Command Mode

Exec > Global Configuration

Syntax

uri-version uri_version [ full-version full_version ] 

full-version full_version

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

Must be a string.

uri-version uri_version

Specify the URI version.

Must be a string in the pattern v\d.

Usage Guidelines

Use this command to configure URI version information.

group nrf mgmt

Configures the NRF self-management group parameters.

Command Mode

Exec > Global Configuration

Syntax

mgmt group_name [ nrf-type nrf_type ] 

mgmt group_name

Specify name of the NRF self-management group.

Must be a string.

nrf-type nrf_type

Specify the NRF type.

Must be one of the following:

  • PLMN : PLMN.

  • SHARED : SHARED.

  • SLICE-LOCAL : SLICE-LOCAL.

Usage Guidelines

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

group nrf mgmt service type nrf

Configures the NRF self-management service information.

Command Mode

Exec > Global Configuration

Syntax

nrf nrf-service-name nrf_service_name [ responsetimeout response_timeout ] 

nrf-service-name nrf_service_name

Specify name of the NRF service.

Must be one of the following:

  • nnrf-nfm

responsetimeout response_timeout

Specify the response timeout interval in milliseconds.

Must be an integer.

Default Value: 2000.

Usage Guidelines

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

group nrf mgmt service type nrf endpoint-profile

Configures endpoint profile parameters.

Command Mode

Exec > Global Configuration

Syntax

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

api-root api_root

Specify the API root.

Must be a string.

api-uri-prefix api_uri_prefix

Specify the API URI prefix.

Must be a string.

endpoint-profile endpoint_profile_name

Specify name of the endpoint profile.

Must be a string.

uri-scheme uri_scheme

Specify the URI scheme.

Must be one of the following:

  • http

  • https

Usage Guidelines

Use this command to configure endpoint profile parameters.

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

Configures name of the endpoint.

Command Mode

Exec > Global Configuration

Syntax

endpoint-name endpoint_name [ priority endpoint_priority ] 

max-retry-count max_retry_count

Specify the maximum retry count.

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

Default Value: 3.

priority endpoint_priority

Specify the node priority for endpoint.

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

endpoint_name

Specify name of the endpoint.

Must be a string.

Usage Guidelines

Use this command to configure the name of the endpoint.

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

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

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

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

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

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

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

Configures version information.

Command Mode

Exec > Global Configuration

Syntax

uri-version uri_version [ full-version full_version ] 

full-version full_version

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

Must be a string.

uri-version uri_version

Specify the URI version.

Must be a string in the pattern v\d.

Usage Guidelines

Use this command to configure the version information.

gtpp group

Configures GTPP group related parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

gtpp gtpp_group_name 

gtpp_group_name

Specify name of the GTPP group.

Must be a string of 1-63 characters.

Usage Guidelines

Use this command to configure GTPP group related parameters.

gtpp group gtpp egcdr final-record closing-cause

Configures closing cause for final EGCDR.

Command Mode

Exec > Global Configuration (config) > GTPP Group Configuration (config-group-gtpp_group_name )

Syntax

gtpp egcdr final-record closing-cause { same-in-all-partials | unique } 

same-in-all-partials

Specify same closing cause for multiple final EGCDR(s).

unique

Specify unique closing cause for final EGCDR.

Usage Guidelines

Use this command to configure closing cause for final EGCDR.

gtpp group gtpp egcdr losdv-max-containers

Configures maximum number of LoSDV containers in one EGCDR.

Command Mode

Exec > Global Configuration (config) > GTPP Group Configuration (config-group-gtpp_group_name )

Syntax

gtpp egcdr losdv-max-containers max_containers 

losdv-max-containers max_containers

Specify the number of LOSDV containers.

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

Usage Guidelines

Use this command to configure the maximum number of LoSDV containers in one EGCDR.

gtpp group gtpp egcdr service-data-flow threshold

Configures service data flow related parameters.

Command Mode

Exec > Global Configuration (config) > GTPP Group Configuration (config-group-gtpp_group_name )

Syntax

gtpp egcdr service-data-flow threshold interval duration 

interval duration

Specify the time interval, in seconds, to close the eG-CDR/P-CDR if the minimum time duration thresholds for service data flow containers satisfied in flow-based charging. By default, this option is disabled.

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

Usage Guidelines

Use this command to assign volume or interval values to the interim GCDRs.

gtpp group gtpp egcdr service-data-flow threshold volume

Configures the uplink/downlink volume octet counts for the generation of interim GCDRs.

Command Mode

Exec > Global Configuration (config) > GTPP Group Configuration (config-group-gtpp_group_name )

Syntax

gtpp egcdr service-data-flow threshold volume { [ downlink bytes ] [ total bytes ] [ uplink bytes ] } 

downlink bytes

Specify the limit for the number of downlink octets after which the eG-CDR/P-CDR is closed.

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

total bytes

Specify the limit for the total number of octets (uplink+downlink) after which the eG-CDR/P-CDR is closed.

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

uplink bytes

Specify the limit for the number of uplink octets after which the eG-CDR/P-CDR is closed.

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

Usage Guidelines

Use this command to configure the uplink/downlink volume octet counts for the generation of interim GCDRs.

gtpp group gtpp egcdr service-idle-timeout

Enables configuration for service idle out closure of LOSDV container.

Command Mode

Exec > Global Configuration (config) > GTPP Group Configuration (config-group-gtpp_group_name )

Syntax

gtpp egcdr service-idle-timeout { 0 | service_idle_timeout } 

0

Specify no service-idle-timeout trigger.

Must be one of the following:

  • 0

service_idle_timeout

Specify time limit in seconds for service-idle-timeout.

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

Usage Guidelines

Use this command to enable configuration for service idle out closure.

gtpp group gtpp trigger

Configures triggers for CDR.

Command Mode

Exec > Global Configuration (config) > GTPP Group Configuration (config-group-gtpp_group_name )

Syntax

gtpp trigger { time-limit | volume-limit } 

time-limit

When this trigger is disabled, no partial record closure occurs when the configured time limit is reached. Default: Enabled.

volume-limit

When this trigger is disabled no partial record closure occurs when volume limit is reached. Default: Enabled.

Usage Guidelines

Use this command to configure triggers for CDR.

gtpp group gtpp trigger egcdr

Enables or disables and configures eGCDR-related parameters.

Command Mode

Exec > Global Configuration (config) > GTPP Group Configuration (config-group-gtpp_group_name )

Syntax

gtpp trigger egcdr max-losdv 

max-losdv

Enable trigger for eGCDR release at MAX LoSDV containers.

Usage Guidelines

Use this command to enable or disable and configure eGCDR-related parameters.

help

Displays help information for a specified command.

Privilege Level

Security Administrator, Administrator

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.

Privilege Level

Security Administrator, Administrator

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.

Privilege Level

Security Administrator, Administrator

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.

Privilege Level

Security Administrator, Administrator

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.

Privilege Level

Security Administrator, Administrator

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.

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 default verbosity level.

Must be one of the following:

  • debug

  • off

  • production

  • trace

Default Value: trace.

podType pod_type

Specify the pod type.

Must be one of the following:

  • application

  • load-balancer

  • protocol

  • service

Usage Guidelines

Use this command to configure verbose configuration parameters.

infra metrics verbose verboseLevels metrics metricsList

Configures the metrics verbose level configuration.

Command Mode

Exec > Global Configuration (config)

Syntax

metrics metric_name level metric_verbose_level granular-labels granular_labels 

granular-labels granular_labels

Specify the granular labels.

Must be a string.

level metric_verbose_level

Specify the metric verbosity level.

Must be one of the following:

  • debug

  • off

  • production

  • trace

Default Value: trace.

metric_name

Specify name of the metric.

Must be a string.

Usage Guidelines

Use this command to configure the metrics verbose level configuration.

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>).

endpoint-gtpprime

Sets the storage size limit (default 1 GB), which is applicable when k8s use-volume-claim Pod is set to true.

Command Mode

Exec

Syntax

 instance instance-id instance_id 
   endpoint gtpprime 
      storage storage_capacity 
      replicas replicas_count 
      nodes nodes_count 
      interface Gz  
        vip-ip   vip_ip vip-port  

endpoint gtpprime

Specifiy the following parameters to configure an endpoint.

  • storage storage_capacity —Specify the storage size of persistent volume in GB. Must be an integer in the range of 1-100.


    Note


    CLI doesn't allow changing storage size while system is running. To change the storage size, bring the system down first.


  • replicas replicas_count —Specify the number of replicas per node. Must be an integer.

  • nodes nodes_count —This property is ignored. You may skip configuring it.

  • interface Gz : Configure the Gz interface details, such as vip IPv4 address, vip port, vip interface, and VRF details.


    Note


    When the system is active and under the Gz Interface, if there are any add or update vip configurations to use a new value, ensure to restart the udp-proxy.

Usage Guidelines

Use this command to set the storage size limit (default 1 GB), which is applicable when k8s use-volume-claim Pod is set to true.

Ensure to configure GTPP profiles charging agent ip address and ports in the Endpoint under the Gz interface.


Note


The gtpp-ep always ignores nodes config. When k8s single-node is set to false, it spawns 2 replicas of gtpp-ep in the Active or Standby mode independent of replicas and nodes configuration.


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 | internal-vip{ smf_udp_proxy_internal_vip }| vip-ip{ client_ipv4_address }] 

certificate-name certificate_alias_name

Specify the alias name for the certificate.

dscp dscp_value

Specify the DSCP value.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

enable-cpu-optimization { false | true }

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

Must be one of the following:

  • false

  • true

Default Value: true.

enable-go-encdec { false | true }

Specify whether to enable Go-based encoder-decoder in GTP protocol message handling or not. 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 { smf_udp_proxy_internal_vip }

Specify the internal VIP.

Must be a string.

vip-ip { client_ipv4_address }

Specify the IP address of the dynamic authorization client. ipv4_address must be in standard IPv4 dotted decimal notation.

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 diameter

Configures the Diameter endpoint parameters.

Command Mode

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

Syntax

endpoint diameter [ interface { gx | gy }  [ vip-ip  ip_address [ vip-interface  interface_name| vip-port vip_port | vrf vrf_name ] ] ] 

endpoint diameter

Specify the endpoint name as Diameter.

interface { gx | gy }

For Diameter endpoint, select gx or gy interface.

vip-ip ip_address

Specify the IPv4 address of the configured endpoint.

vip-interface interface_name

Specify the interface name.


Note


vip-interface is a bonded interface which is associated with VRF.


vip-port vip_port

Specify the port number of endpoint.

vrf vrf_name

Specify the VRF name defined using global VRF configuration.

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 gtpprime

Configures GTP Prime endpoint parameters.

Command Mode

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

Syntax

endpoint gtpprime [ storage storage_capacity| replicas replicas_count| nodes nodes_count  | interface Gz [ vip-ip  vip_ip vip-port vip-port vip-interface vip-interface vrf vrf ] ] 

storagestorage_capacity

Specify the storage size of persistent volume in GB. Must be an integer in the range of 1-100.


Note


CLI doesn't allow changing storage size while system is running. To change the storage size, you must make the system inactive.


replicas replicas_count

Specify the number of replicas per node. Must be an integer.

nodes nodes_count

(Optional) This property is ignored. You may skip configuring it.

interface Gz [ vip-ip vip_ip vip-port vip-port vip-interface vip-interface vrf vrf ]

Configure the Gz interface details, such as vip IPv4 address, vip port, vip interface, and VRF details.


Note


When the system is active and under the Gz interface, if there are any add or update vip configurations to use a new value, ensure to restart the udp-proxy.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

enable-go-encdec { false | true }

Specify whether to enable Go-based encoder-decoder in GTP protocol message handling. By default, it is enabled.

Must be one of the following:

  • false

  • true

Default Value: true.

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.

max-retransmissions max_retransmissions

Specify the maximum number of retries for GTP echo request.

retransmission-timeout retransmission_timeout

Specify the echo retransmission timeout in seconds.

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.

drop

Specify to drop if threshold is hit.

exclude

Specify to not apply Overload Control Mechanism for priority messages.

message-priority message_priority

Specify message priorities higher or equal to the configured value.

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

redirect-code redirect_status_code

Specify the redirect status code if threshold is hit.

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

redirect

Specify to redirect if threshold is hit.

reject-code reject_status_code

Specify reject status code if threshold is hit.

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

reject

Specify to reject if threshold is hit.

url redirection_url

Specify the redirection URL of new host.

Must be a string.

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.

drop

Specify to drop if threshold is hit.

exclude

Specify to not apply Overload Control Mechanism for priority messages.

high high_threshold

Specify the high threshold limit for outstanding requests.

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

message-priority message_priority

Specify message priorities higher or equal to the configured value.

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

redirect-code redirect_status_code

Specify the redirect status code if threshold is hit.

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

redirect

Specify to redirect if threshold is hit.

reject-code reject_status_code

Specify reject status code if threshold is hit.

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

reject

Specify to reject if threshold is hit.

url redirection_url

Specify the redirection URL of new host.

Must be a string.

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.

drop

Specify to drop if threshold is hit.

exclude

Specify to not apply Overload Control Mechanism for priority messages.

low low_threshold

Specify the low threshold limit for outstanding requests.

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

message-priority message_priority

Specify message priorities higher or equal to the configured value.

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

redirect-code redirect_status_code

Specify the redirect status code if threshold is hit.

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

redirect

Specify to redirect if threshold is hit.

reject-code reject_status_code

Specify reject status code if threshold is hit.

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

reject

Specify to reject if threshold is hit.

url redirection_url

Specify the redirection URL of new host.

Must be a string.

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.

drop

Specify to drop if threshold is hit.

exclude

Specify to not apply Overload Control Mechanism for priority messages.

message-priority message_priority

Specify message priorities higher or equal to the configured value.

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

redirect-code redirect_status_code

Specify the redirect status code if threshold is hit.

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

redirect

Specify to redirect if threshold is hit.

reject-code reject_status_code

Specify reject status code if threshold is hit.

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

reject

Specify to reject if threshold is hit.

url redirection_url

Specify the redirection URL of new host.

Must be a string.

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.

drop

Specify to drop if threshold is hit.

exclude

Specify to not apply Overload Control Mechanism for priority messages.

high high_threshold

Specify the high threshold limit for outstanding requests.

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

message-priority message_priority

Specify message priorities higher or equal to the configured value.

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

redirect-code redirect_status_code

Specify the redirect status code if threshold is hit.

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

redirect

Specify to redirect if threshold is hit.

reject-code reject_status_code

Specify reject status code if threshold is hit.

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

reject

Specify to reject if threshold is hit.

url redirection_url

Specify the redirection URL of new host.

Must be a string.

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.

drop

Specify to drop if threshold is hit.

exclude

Specify to not apply Overload Control Mechanism for priority messages.

low low_threshold

Specify the low threshold limit for outstanding requests.

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

message-priority message_priority

Specify message priorities higher or equal to the configured value.

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

redirect-code redirect_status_code

Specify the redirect status code if threshold is hit.

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

redirect

Specify to redirect if threshold is hit.

reject-code reject_status_code

Specify reject status code if threshold is hit.

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

reject

Specify to reject if threshold is hit.

url redirection_url

Specify the redirection URL of new host.

Must be a string.

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 

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.

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.

Usage Guidelines

Use this command to configure the message configuration parameters.

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

Configures the discard behavior to apply when the interface is overloaded.

Command Mode

Exec > Global Configuration (config)

Syntax

discard-behavior reject reject-code reject_status_code drop { false | true } 

drop { false | true }

Specify whether to drop if interface is overloaded.

Must be one of the following:

  • false

  • true

Default Value: false.

reject-code reject_status_code

Specify the reject status code if the interface is overloaded.

Must be an integer.

reject

Specify to reject the incoming message if the interface is overloaded.

Usage Guidelines

Use this command to configure the discard behavior to apply when the interface is overloaded.

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 chapter.

-Or-

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

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

drop

Specify to drop if threshold is hit.

exclude

Specify to not apply Overload Control Mechanism for priority messages.

message-priority message_priority

Specify message priorities higher or equal to the configured value.

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

redirect-code redirect_status_code

Specify the redirect status code if threshold is hit.

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

redirect

Specify to redirect if threshold is hit.

reject-code reject_status_code

Specify reject status code if threshold is hit.

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

reject

Specify to reject if threshold is hit.

url redirection_url

Specify the redirection URL of new host.

Must be a string.

Usage Guidelines

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

instance instance-id endpoint ep 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.

drop

Specify to drop if threshold is hit.

exclude

Specify to not apply Overload Control Mechanism for priority messages.

high high_threshold

Specify the high threshold limit for outstanding requests.

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

message-priority message_priority

Specify message priorities higher or equal to the configured value.

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

redirect-code redirect_status_code

Specify the redirect status code if threshold is hit.

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

redirect

Specify to redirect if threshold is hit.

reject-code reject_status_code

Specify reject status code if threshold is hit.

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

reject

Specify to reject if threshold is hit.

url redirection_url

Specify the redirection URL of new host.

Must be a string.

Usage Guidelines

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

instance instance-id endpoint ep 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.

drop

Specify to drop if threshold is hit.

exclude

Specify to not apply Overload Control Mechanism for priority messages.

low low_threshold

Specify the low threshold limit for outstanding requests.

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

message-priority message_priority

Specify message priorities higher or equal to the configured value.

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

redirect-code redirect_status_code

Specify the redirect status code if threshold is hit.

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

redirect

Specify to redirect if threshold is hit.

reject-code reject_status_code

Specify reject status code if threshold is hit.

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

reject

Specify to reject if threshold is hit.

url redirection_url

Specify the redirection URL of new host.

Must be a string.

Usage Guidelines

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

instance instance-id endpoint ep 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.

drop

Specify to drop if threshold is hit.

exclude

Specify to not apply Overload Control Mechanism for priority messages.

message-priority message_priority

Specify message priorities higher or equal to the configured value.

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

redirect-code redirect_status_code

Specify the redirect status code if threshold is hit.

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

redirect

Specify to redirect if threshold is hit.

reject-code reject_status_code

Specify reject status code if threshold is hit.

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

reject

Specify to reject if threshold is hit.

url redirection_url

Specify the redirection URL of new host.

Must be a string.

Usage Guidelines

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

instance instance-id endpoint ep 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.

drop

Specify to drop if threshold is hit.

exclude

Specify to not apply Overload Control Mechanism for priority messages.

high high_threshold

Specify the high threshold limit for outstanding requests.

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

message-priority message_priority

Specify message priorities higher or equal to the configured value.

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

redirect-code redirect_status_code

Specify the redirect status code if threshold is hit.

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

redirect

Specify to redirect if threshold is hit.

reject-code reject_status_code

Specify reject status code if threshold is hit.

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

reject

Specify to reject if threshold is hit.

url redirection_url

Specify the redirection URL of new host.

Must be a string.

Usage Guidelines

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

instance instance-id endpoint ep 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.

drop

Specify to drop if threshold is hit.

exclude

Specify to not apply Overload Control Mechanism for priority messages.

low low_threshold

Specify the low threshold limit for outstanding requests.

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

message-priority message_priority

Specify message priorities higher or equal to the configured value.

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

redirect-code redirect_status_code

Specify the redirect status code if threshold is hit.

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

redirect

Specify to redirect if threshold is hit.

reject-code reject_status_code

Specify reject status code if threshold is hit.

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

reject

Specify to reject if threshold is hit.

url redirection_url

Specify the redirection URL of new host.

Must be a string.

Usage Guidelines

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

instance instance-id endpoint ep 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 

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.

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.

Usage Guidelines

Use this command to configure the message configuration parameters.

instance instance-id endpoint ep overload-control msg-type messageConfigs discard-behavior

Configures the discard behavior to apply when the interface is overloaded.

Command Mode

Exec > Global Configuration (config)

Syntax

discard-behavior reject reject-code reject_status_code drop { false | true } 

drop { false | true }

Specify whether to drop if interface is overloaded.

Must be one of the following:

  • false

  • true

Default Value: false.

reject-code reject_status_code

Specify the reject status code if the interface is overloaded.

Must be an integer.

reject

Specify to reject the incoming message if the interface is overloaded.

Usage Guidelines

Use this command to configure the discard behavior to apply when the interface is overloaded.

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 chapter.

-Or-

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

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.

instance instance-id endpoint gtp interface interface-name

Configures encoder and decoder for the IEs that are associated with the GTPC endpoint pod.

Command Mode

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

Syntax

endpoint gtp interface  interface_name  enable-direct-encdec true | false  

interface interface_name

Specify the interface name, such as s5e and s11.

enable-direct-encdec { true | false } dscp_value

Specify whether to enable the encoder and decoder to optimize the encoding and decoding of the IEs that are associated with the GTPC endpoint pod. By default, it is disabled.

Must be one of the following:

  • false

  • true

Usage Guidelines

Use this command to configure the encoder and decoder for the IEs that are associated with the GTPC endpoint pod.

instances instance

Configures SMF instance.

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 SMF instance.

ipam

Configures IP Address Management (IPAM) configuration parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

ipam 

Usage Guidelines

Use this command to configure IPAM configuration parameters.

exec-ipam reclaim-chunk

Configures SMF to instantly reclaim under-utilized IP chunks.

Command Mode

Exec

Syntax

exec-ipam reclaim-chunk { utilization-threshold utilization_threshold inactivity-threshold inactivity_threshold [ instance grInstance ] [ pool-name poolName ] [ chunk-start-ip ip ] } 

exec-ipam

Executes IPAM commands.

reclaim-chunk

Executes IP-chunk reclamation procedure.

utilization-threshold utilization_threshold

Configures the utilization threshold for reclamation.

inactivity-threshold inactivity_threshold

Configures inactivity threshold for reclamation in seconds.

instance grInstance

Configures the GR Instance for which the auto-reclamation process is to be executed.

pool-name poolName

Specifies the pool for which the auto-reclamation process is to be executed.

chunk-start-ip ip

Specifies the IP with which the chunk starts for which the auto-reclamation process is to be executed.

Usage Guidelines

Use this command to instantly re-claim under-utilized IP chunks.

ipam dp

Displays IPAM data-plane allocations.

Command Mode

Exec

Syntax

show ipam dp dp_name [ options ] 

Usage Guidelines

Use this command to view IPAM data-plane allocations.

ipam instance

Configures the instance configuration parameters.

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam)

Syntax

instance instance_id 

instance instance_id

Specify the instance ID.

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

Usage Guidelines

Use this command to configure the instance configuration parameters.

ipam instance address-pool

Configures IPAM address pools.

Command Mode

Exec > Global Configuration > IPAM Configuration

Syntax

address-pool address_pool_name [ static | offline | vrf-name vrf_name ] 

address-pool address_pool_name

Specify name of the address pool.

Must be a string of 1-128 characters in the ipam-str pattern. For information on the ipam-str pattern, see the Input Pattern Types chapter.

address-quarantine-qsize max_ips_in_quarantine_queue

Specify the maximum number of IPs to be held in quarantine queue per-dp, per-af, per-instance.

Must be an integer.

address-quarantine-timer address_quarantine_timer_interval

Specify the address quarantine timer interval in seconds.

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

Default Value: 4.

offline

Specify the pool as an offline pool.

static

Specify the pool as a static pool.

vrf-name vrf_name

Specify name of the VRF.

Must be a string of 1-128 characters in the ipam-str pattern. For information on the ipam-str pattern, see the Input Pattern Types chapter.

Usage Guidelines

Use this command to configure IPAM address pools.

ipam instance address-pool ipv4

Configures IPv4 parameters.

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id ) > Address Pool Configuration (config-address-pool-address_pool_name )

Syntax

ipv4 

Usage Guidelines

Use this command to configure IPv4 parameters.

ipam instance address-pool ipv4 address-range

Configures IPv4 address ranges.

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id ) > Address Pool Configuration (config-address-pool-address_pool_name ) > IPv4 Configuration (config-ipv4)

Syntax

address-range start_ipv4_address end_ipv4_address [ offline ] 

address-range start_ipv4_address

Specify the start address of the IPv4 address range.

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

nexthop-forwarding-address nexthop_forwarding_address

Specify the nexthop forwarding address.

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

offline

Specify the IPv4 address range as offline.

end_ipv4_address

Specify the end address of the IPv4 address range.

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

Usage Guidelines

Use this command to configure IPv4 address ranges.

ipam instance address-pool ipv4 chunk-group

Configures IPv4 chunk group size for a pool.

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id ) > Address Pool Configuration (config-address-pool-address_pool_name ) > IPv4 Configuration (config-ipv4)

Syntax

chunk-group { chunks-per-group { 2 | 4| 8 } reserve-contiguous-groups } 

chunk-group

Allows to configure chunk-groups for a pool.

chunks-per-group { 2 | 4| 8 }

Defines the number of chunks in a chunk group. The values can be either 2, 4, or 8.

reserve-contiguous-groups

Allows reserving contiguous chunk-groups as per max-upf-session defined in the UPF or DNN profile.

Usage Guidelines

Use this command to configure IPv4 chunk group.

ipam instance address-pool ipv4 prefix-range

Configures prefix range parameters.

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id ) > Address Pool Configuration (config-address-pool-address_pool_name ) > IPv4 Configuration (config-ipv4)

Syntax

prefix-range prefix_value length prefix_length [ offline ] 

length prefix_length

Specify the prefix length.

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

nexthop-forwarding-address nexthop_forwarding_address

Specify the nexthop forwarding address.

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

offline

Specify to set the IPv4 prefix to offline mode.

prefix prefix_value

Specify the prefix value.

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

Usage Guidelines

Use this command to configure prefix range parameters.

ipam instance address-pool ipv4 split-size

Configures chunk split size.

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id ) > Address Pool Configuration (config-address-pool-address_pool_name ) > IPv4 Configuration (config-ipv4)

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id ) > Address Pool Configuration (config-address-pool-address_pool_name ) > IPv6 Configuration (config-ipv6) > Address Range Configuration (config-address-ranges)

Syntax

split-size [ [ no-split ] [ per-cache number_of_addresses ] [ per-dp number_of_addresses ] ] 

no-split

Specify not to split the address range into smaller chunks.

per-cache number_of_addresses

Specify the number of addresses per chunk for IPAM cache allocation. Specify in power of 2.

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

per-dp number_of_addresses

Specify the number of addresses per chunk for data-plane allocation. Specify in power of 2.

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

Usage Guidelines

Use this command to configure chunk split sizes.

ipam instance address-pool ipv4 threshold

Configures pool thresholds.

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id ) > Address Pool Configuration (config-address-pool-address_pool_name ) > IPv4 Configuration (config-ipv4) > Address Range Configuration (config-address-ranges)

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id ) > Address Pool Configuration (config-address-pool-address_pool_name ) > IPv6 Configuration (config-ipv6) > Address Range Configuration (config-address-ranges)

Syntax

threshold upper-threshold upper_threshold 

upper-threshold upper_threshold

Specify the upper threshold in percentage.

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

Usage Guidelines

Use this command to configure pool thresholds.

ipam instance address-pool ipv6

Configures IPv6 parameters.

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id ) > Address Pool Configuration (config-address-pool-address_pool_name )

Syntax

address-range 

Usage Guidelines

Use this command to configure IPv6 parameters.

ipam instance address-pool ipv6 address-ranges address-range

Configures IPv6 address ranges.

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id ) > Address Pool Configuration (config-address-pool-address_pool_name ) > IPv6 Configuration (config-ipv6)

Syntax

address-ranges address-range start_ipv6_address end_ipv6_address [ offline ] 

offline

Specify the IPv6 address range as offline.

end_ipv6_address

Specify the end address of the IPv6 address range.

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

start_ipv6_address

Specify the start address of the IPv6 address range.

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

Usage Guidelines

Use this command to configure IPv6 address ranges.

ipam instance address-pool ipv6 address-ranges prefix-range

Configures prefix range parameters.

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id ) > Address Pool Configuration (config-address-pool-address_pool_name ) > IPv6 Configuration (config-ipv6)

Syntax

prefix-ranges prefix-range [ prefix prefix_value ] [ length prefix_length ] [ offline ] 

length prefix_length

Specify the prefix length.

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

offline

Specify to set the IPv6 prefix to offline mode.

prefix prefix_value

Specify the prefix value.

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

Usage Guidelines

Use this command to configure prefix range parameters.

ipam instance address-pool ipv6 address-ranges chunk-group

Configures chunk group for IPv6 address ranges.

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id ) > Address Pool Configuration (config-address-pool-address_pool_name ) > IPv6 Configuration (config-ipv6)

Syntax

chunk-group { chunks-per-group { 2 | 4| 8 } reserve-contiguous-groups } 

chunk-group

This CLI allows to configure chunk-groups for a pool.

chunks-per-group { 2 | 4| 8 }

Defines the number of chunks in a chunk group. The values can be either 2, 4, or 8.

reserve-contiguous-groups

Allows reserving contiguous chunk-groups as per max-upf-session defined in the UPF or DNN profile.

Usage Guidelines

Use this command to configure IPv6 chunk group size for address range.

ipam instance address-pool ipv6 address-ranges split-size

Configures chunk split size.

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id ) > Address Pool Configuration (config-address-pool-address_pool_name ) > IPv4 Configuration (config-ipv4)

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id ) > Address Pool Configuration (config-address-pool-address_pool_name ) > IPv6 Configuration (config-ipv6) > Address Range Configuration (config-address-ranges)

Syntax

split-size [ [ no-split ] [ per-cache number_of_addresses ] [ per-dp number_of_addresses ] ] 

no-split

Specify not to split the address range into smaller chunks.

per-cache number_of_addresses

Specify the number of addresses per chunk for IPAM cache allocation. Specify in power of 2.

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

per-dp number_of_addresses

Specify the number of addresses per chunk for data-plane allocation. Specify in power of 2.

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

Usage Guidelines

Use this command to configure chunk split sizes.

ipam instance address-pool ipv6 address-ranges threshold

Configures pool thresholds.

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id ) > Address Pool Configuration (config-address-pool-address_pool_name ) > IPv4 Configuration (config-ipv4) > Address Range Configuration (config-address-ranges)

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id ) > Address Pool Configuration (config-address-pool-address_pool_name ) > IPv6 Configuration (config-ipv6) > Address Range Configuration (config-address-ranges)

Syntax

threshold upper-threshold upper_threshold 

upper-threshold upper_threshold

Specify the upper threshold in percentage.

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

Usage Guidelines

Use this command to configure pool thresholds.

ipam instance address-pool ipv6 prefix-ranges prefix-range

Configures IPv6 prefix ranges.

Command Mode

Exec > Global Configuration > IPAM Configuration > Address Pool Configuration > Prefix Ranges Configuration

Syntax

prefix-range prefix_value length prefix_length [ offline ] 

length prefix_length

Specify the prefix length.

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

offline

Specify the IPv6 prefix range as offline.

prefix-range prefix_value

Specify the IPv6 prefix range.

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

Usage Guidelines

Use this command to configure IPv6 prefix ranges.

ipam instance address-pool ipv6 prefix-ranges chunk-group

Configures chunk group for IPv6 prefix ranges.

Command Mode

Exec > Global Configuration > IPAM Configuration > Address Pool Configuration > Prefix Ranges Configuration

Syntax

chunk-group { chunks-per-group { 2 | 4| 8 } reserve-contiguous-groups } 

chunk-group

This CLI allows to configure chunk-groups for a pool.

chunks-per-group { 2 | 4| 8 }

Defines the number of chunks in a chunk group. The values can be either 2, 4, or 8.

reserve-contiguous-groups

Allows reserving contiguous chunk-groups as per max-upf-session defined in the UPF or DNN profile.

Usage Guidelines

Use this command to configure IPv6 chunk group size for prefix range.

ipam instance address-pool ipv6 prefix-ranges split-size

Configures chunk split size.

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id ) > Address Pool Configuration (config-address-pool-address_pool_name ) > IPv4 Configuration (config-ipv4)

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id ) > Address Pool Configuration (config-address-pool-address_pool_name ) > IPv6 Configuration (config-ipv6) > Address Range Configuration (config-address-ranges)

Syntax

split-size [ [ no-split ] [ per-cache number_of_addresses ] [ per-dp number_of_addresses ] ] 

no-split

Specify not to split the address range into smaller chunks.

per-cache number_of_addresses

Specify the number of addresses per chunk for IPAM cache allocation. Specify in power of 2.

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

per-dp number_of_addresses

Specify the number of addresses per chunk for data-plane allocation. Specify in power of 2.

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

Usage Guidelines

Use this command to configure chunk split sizes.

ipam instance address-pool ipv6 prefix-ranges threshold

Configures pool thresholds.

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id ) > Address Pool Configuration (config-address-pool-address_pool_name ) > IPv4 Configuration (config-ipv4) > Address Range Configuration (config-address-ranges)

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id ) > Address Pool Configuration (config-address-pool-address_pool_name ) > IPv6 Configuration (config-ipv6) > Address Range Configuration (config-address-ranges)

Syntax

threshold upper-threshold upper_threshold 

upper-threshold upper_threshold

Specify the upper threshold in percentage.

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

Usage Guidelines

Use this command to configure pool thresholds.

ipam instance address-pool tags

Configures address pool tags.

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id ) > Address Pool Configuration (config-address-pool-address_pool_name )

Syntax

tags [ [ dnn dnn ] [ nssai nssai ] [ serving-area serving_area ] ] 

dnn dnn

Specify the DNN.

Must be a string.

nssai nssai

Specify the NSSAI.

Must be a string.

serving-area serving_area

Specify the serving area.

Must be a string.

Usage Guidelines

Use this command to configure address pool tags.

ipam instance audit chunk

Configures IPAM to enable or disable the reconciliation of IP chunks between SMF and UPF.

Command Mode

Exec > Global Configuration > IPAM Configuration

Syntax

audit chunk [ local | none ]   

audit chunk [ local | none ]

Configures audit activity on IPAM. It has two possible values:

  • local —Enables the feature.

  • none —Disables the feature.

Default value is none .

Usage Guidelines

Use this command to enable or disable the reconciliation of IP chunks between SMF and UPF.

ipam instance chunk-reclamation

Configures SMF to auto re-claim under-utilized IP chunks.

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id )

Syntax

chunk-reclamation { schedule tod-hour tod_hour_value schedule tod-minute tod_min_value utilization-threshold utilization_threshold inactivity-threshold inactivity_threshold } 

chunk-reclamation

Configures periodic IP chunk reclamation process.

schedule

Configure the Time-of-day values for the chunk-reclamation process.

tod-hour tod_hour_value

Configure the Time-of-day hour value for the chunk-reclamation process. The value range for schedule tod-hour is <0-23>.

tod-minute tod_min_value

This CLI configures the Time-of-day minute value for the chunk-reclamation process. The value range for tod-minute is <0-59>.

utilization-threshold utilization_threshold

This CLI configures the utilization threshold for reclamation. The value range for utilization-threshold is <0-20>. The default value is 2.

inactivity-threshold inactivity_threshold

This CLI configures the inactivity threshold for reclamation. The value range for inactivity-threshold is <0-3600>. The default value is 1800.

Usage Guidelines

Use this command to auto re-claim under-utilized IP chunks.

ipam instance min-dp-addr-size

Configures the minimum number of addresses to reserve per upf, per nm, per pool/tag.

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id )

Syntax

min-dp-addr-size [ [ ipv4-addr min_to_reserve ] [ ipv6-addr min_to_reserve ] [ ipv6-prefix min_to_reserve ] ] 

ipv4-addr min_to_reserve

Specify the minimum number of IPv4 address to reserve.

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

ipv6-addr min_to_reserve

Specify the minimum number of IPv6 address to reserve.

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

ipv6-prefix min_to_reserve

Specify the minimum number of IPv6 prefix to reserve.

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

Usage Guidelines

Use this command to configure the minimum number of addresses to reserve per upf, per nm, per pool/tag.

ipam instance source

Configures pool-datastore source selection.

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id )

Syntax

source local 

local

Specify to use local address pool datastore.

Usage Guidelines

Use this command to configure pool-datastore source selection.

ipam instance source external ipam

Configures external IPAM server for pool information.

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id )

Syntax

source external ipam [ [ host ip_address ] [ port port_number ] [ vendor vendor_id ] ] 

host ip_address

Specify IP address of the IPAM server.

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

-Or-

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

port port_number

Specify port number of the IPAM server.

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

vendor vendor_id

Specify the IPAM server's vendor ID. Default: cisco.

Must be one of the following:

  • cisco

Usage Guidelines

Use this command to configure external IPAM server for pool information.

ipam instance threshold

Configures global upper thresholds.

Command Mode

Exec > Global Configuration (config) > IPAM Configuration (config-ipam) > Instance Configuration (config-instance-instance_id )

Syntax

threshold [ [ ipv4-addr ipv4_address_threshold ] | [ ipv6-addr ipv6_address_threshold ] | [ ipv6-prefix ipv6_prefix_threshold ] ] 

ipv4-addr ipv4_address_threshold

Specify the IPv4 address threshold in percentage.

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

ipv6-addr ipv6_address_threshold

Specify the IPv6 address threshold in percentage.

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

ipv6-prefix ipv6_prefix_threshold

Specify the IPv6 prefix threshold in percentage.

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

Usage Guidelines

Use this command to configure global upper thresholds.

ipam pool

Displays IPAM pool allocation information.

Command Mode

Exec

Syntax

show ipam pool pool_name 

Usage Guidelines

Use this command to view IPAM pool allocation information.

ipam pool ipv4-addr

Displays IPAM pool IPv4 address information.

Command Mode

Exec

Syntax

show ipam pool pool_name ipv4-addr 

Usage Guidelines

Use this command to view IPAM pool IPv4 address information.

ipam pool ipv6-addr

Displays IPAM pool IPv6 address information.

Command Mode

Exec

Syntax

show ipam pool pool_name ipv6-addr 

Usage Guidelines

Use this command to view IPAM pool IPv6 address information.

job

Suspends the jobs that are running in the background.

Privilege Level

Security Administrator, Administrator

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.

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.

leaf-prompting

Enables or disables automatic querying for leaf values.

Privilege Level

Security Administrator, Administrator

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.

Privilege Level

Security Administrator, Administrator

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.

Privilege Level

Security Administrator, Administrator

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.

Privilege Level

Security Administrator, Administrator

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.

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.

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.

logout

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

Privilege Level

Security Administrator, Administrator

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.

message type

Configures the UDM message types.

Command Mode

Exec > UDM Service Configuration (config)

Syntax

message type { UdmRegistrationReq | UdmSdmGetUESMSubscriptionData | UdmSdmSubscribeToNotification | UdmSdmUnsubscribeToNotification | UdmSubscriptionReq | UdmUecmRegisterSMF  skip optional-ies [ epdgInd | registrationTime ]  | UdmUecmUnregisterSMF } 

message type { UdmRegistrationReq | UdmSdmGetUESMSubscriptionData | UdmSdmSubscribeToNotification | UdmSdmUnsubscribeToNotification | UdmSubscriptionReq | UdmUecmRegisterSMF skip optional-ies [ epdgInd | registrationTime ] | UdmUecmUnregisterSMF }

Configures any one of the following udm subscription message types:

  • UdmRegistrationReq

  • UdmSdmGetUESMSubscriptionData

  • UdmSdmSubscribeToNotification

  • UdmSdmUnsubscribeToNotification UdmSubscriptionReq

  • UdmUecmRegisterSMF

skip optional-ies [ epdgInd | registrationTime ] —Skips ePDG indication or Resgistration Time in the N10 Registration Request.


Note


The skip optional-ies [ epdgInd | registrationTime ] command is available only with UdmUecmRegisterSMF message.

Usage Guidelines

Use this command to configure the UDM message types.

mode debug exec action release-resource

Triggers the resource releasing process for N4 interface per UPF from SMF.

Command Mode

Exec

Syntax

mode debug exec  action release-resource attributes { interface n4 peer { ip upf_ip } } condition { dnn matches dnn-name }  

debug

This keyword indicates that this is a debug mode operational CLI.

exec

This command executes the command to trigger N4 release per UPF from SMF.

action

Triggers an action to be performed.

release-resource

This is an optional command. Upon executing release-resource , the SMF triggers clean-up of subscriber/pool resources to the peer provided.

attributes

Defines the attributes to perform an action.

peer

The UPF peer can be defined using UPF IP address.

interface

Specifies the interface name to trigger the operation for.

condition

Specifies the additional condition to filter the data for selected operation. This is an optional filter.

dnn

Pools associated to this dnn-name will be cleared based on the given operator.

matches

This command verifies the DNN that matches the output modifiers.

Usage Guidelines

Use this command to trigger N4 resources or associations release process per UPF from the SMF.

monitor protocol

Configures the SMF to monitor the protocol.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec

Syntax

monitor protocol { interface interface_name  [ capture-duration duration | gr-instance gr_instance | pcacp yes | | ] | list [ | ] }  

interface interface_name

Specifies the name of interface on which PCAP is captured.

interface_name must be a string of possible values sbi, pfcp, gtpu, gtpc, gtp, radius, and diameter.


Note


For the Diameter interface, SMF uses the Monitor Protocol for packets.


capture-duration duration

duration Specifies the duration, in seconds, during which PCAP is captured.

Must be an integer.

The default value is 300 seconds.

gr-instance gr_instance

Specifies the monitor protocol for given gr-instance only.

grinstance_monitorprotocol must be a string.

pcap yes

Enables PCAP file generation.

The default value is no.

list

Lists monitor protocol files.

[ | ]

Specifies output options:

  • append

  • begin

  • count

  • exclude

  • include

  • linnum

  • more

  • nomore

  • save

  • until

monitor active-instance-traffic

Configures the SMF to monitor the traffic on an active GR instance.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration (config)

Syntax

active-instance-traffic {  no-traffic-duration no_traffic_duration session-threshold session_threshold action { pod-restart | trigger-switch-over  } } 

active-instance-traffic

It is the CLI to configure active traffic monitoring on the pod.

no-traffic-duration no_traffic_duration

Specifies the maximum allowed time (in seconds) of no traffic on an active instance. The value range is 10-300.

session-threshold session_threshold

Minimum session count to start the active instance traffic monitoring. The value range is 10-10000000. The default value is 1000.

action { pod-restart | trigger-switch-over }

Action to take on condition fulfillment. The possible values for this command are pod-restart or trigger-switch-over . The default value is pod-restart .

Usage Guidelines

Use this command to monitor the traffic on an active GR instance.

monitor-protocol cpu-limit

Configures the CPU utilization of pods.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration (config)

Syntax

monitor protocol cpu-limit threshold_percentage 

cpu-limit threshold_percentage

Specifies the CPU utilization threshold percentage, based on which the monitor ptotocol command in the Exec mode is restricted.

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

The default value is 70%.

monitor subscriber

Configures the SMF to monitor the subscribers.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec

Syntax

monitor subscriber [ supi supi | imsi imsi | imei imei [ capture-duration duration  | gr-instancegr_instance | internal-messages yes |  namespace namespace  | nf-service nf-service | transaction-logs yes internal-messages yes | [ | ] ] ] 

supi supi

Specify the subscriber identifier.

Must be a string.

imsi imsi

Specifyes the subscriber IMSI.

Must be a string.

imei imei

Specifyes the subscriber IMEI.

Must be a string.

capture-duration duration

Specifyes the duration in seconds during which PCAP is captured.

Must be an integer.

The default value is 300 seconds.

gr-instance gr_instance

Specifyes the monitor subscriber for given gr-instance only.

Must be an integer.

internal-messages yes |

Specifyes yes in order to enable internal messages.

By default it is disabled.

namespace namespace

Specify sgw or smf.

nf-service nf-service

Specify sgw or smf.

transaction-logs yes internal-messages

Sets to yes in order to enable internal messages.

By default it is disabled.

msid-opt

Clears subscriber data based on MSID.

Command Mode

Exec

Syntax

clear subscriber msid msid [ ebi eps_bearer_id | reactivation { false | true } ] 

ebi eps_bearer_id

Specify the EPS Bearer ID.

Must be a string.

reactivation { false | true }

Specify if reactivation is requested.

Must be one of the following:

  • false

  • true

Usage Guidelines

Use this command to subscriber data based on MSID.

nf-tls ca-certificates

Configures NF TLS certificate name and data configuration parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

nf-tls ca-certificates certificate_alias_name [ cert-data certificate_data ] 

ca-certificates certificate_alias_name

Specify the alias name for the certificate.

Must be a string.

cert-data certificate_data

Specify the certificate data in PEM format.

Must be a string.

Usage Guidelines

Use this command to configure certificate name and data configuration parameters.

nf-tls certificate-status

Displays NF TLS certificate status.

Command Mode

Exec

Syntax

show nf-tls certificate-status [ [ certificate_name ] [ days days_to_expire ] [ podInstance pod_instance ] ] 

days days_to_expire

Specify the number of days for the certificate to expire.

Must be a string.

podInstance pod_instance

Specify the Pod instance.

Must be a string.

certificate_name

Specify name of the certificate.

Must be a string.

Usage Guidelines

Use this command to view certificate status.

nf-tls certificates

Configures NF TLS certificate parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

nf-tls certificates certificate_alias_name [ [ cert-data certificate_data ] [ private-key private_key ] ] 

cert-data certificate_data

Specify the certificate data in PEM format.

Must be a string.

certificates certificate_alias_name

Specify the alias name for the certificate.

Must be a string.

private-key private_key

Specify the certificate private key in PEM format.

Must be a string.

Usage Guidelines

Use this command to configure NF TLS certificate parameters.

no

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

Privilege Level

Security Administrator, Administrator

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.

nodemonitor

Configures the nodemonitor pod to periodically check the operating state of other nodes.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec > Global Configuration (config)

Syntax

nodemonitor mode { 0 | 1 | 2 | 3 interval wait_time } 

mode { 0 | 1 | 2 | 3 interval wait_time}

Enable the node monitoring pod to switch to different modes depending on the operating state of nodes.

  • mode 0 —Disables the node monitoring functionality.

  • mode 1 —Enables the node monitoring and performs self-reboot only after reaching a hardcoded value of 2 seconds when two or more nodes are not reachable. This is the default setting.

  • mode 2 —Enables the node monitoring and performs self-reboot when two or more nodes are not reachable but not all the nodes.

  • mode 3 interval wait_time —Specify the time interval in seconds, after which the node monitoring pod is rebooted when two or more nodes are not reachable.

    wait_time must be an integer in the range of 5–300.

Usage Guidelines

Use this command to configure nodemonitor pod to periodically check the operating state of other nodes.

nrf discovery-info discovery-filter

Displays NF discovery filter information.

Command Mode

Exec > Global Configuration

Syntax

show discovery-filter 

Usage Guidelines

Use this command to view NF discovery filter information.

nrf discovery-info discovery-filter nf-discovery-profile

Displays discovery profile information.

Command Mode

Exec > Global Configuration

Syntax

show nf-discovery-profile 

Usage Guidelines

Use this command to view NF discovery profile information.

nrf discovery-info discovery-filter nf-discovery-profile nf-service

Displays NF service information.

Command Mode

Exec > Global Configuration

Syntax

show nf-service 

Usage Guidelines

Use this command to view NF service information.

nrf registration-info

Displays NRF registration information.

Command Mode

Exec

Syntax

show nrf [ registration-info [ gr-instance gr_instance ] ] 

gr-instance gr_instance

Specify the GR instance ID.

Must be a string.

Usage Guidelines

Use this command to view registration information.

nrf subscription-info

Displays NF subscription information.

Command Mode

Exec > Global Configuration

Syntax

show nrf subscription-info 

Usage Guidelines

Use this command to view NF subscription information.

nssai

Configures the list of DNN profile names.

Command Mode

Exec > Global Configuration (config)

Syntax

nssai name slice_name [ [ dnn profile_names_list ] [ sdt slice_differentiator_type ] [ sst slice_service_type ] [ tai-group-list tai_group_list ] ] 

dnn profile_names_list

Specify the list of actual DNN profile names configured.

Must be a string.

name slice_name

Specify name of the slice.

Must be a string.

sdt slice_differentiator_type

Specify the Slice Differentiator Type (SDT).

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

sst slice_service_type

Specify the Slice/Service Type (SST).

Must be a string in the sst-string255 pattern. For information on the sst-string255 pattern, see the Input Pattern Types chapter.

tai-group-list tai_group_list

Specify the list of TAI groups for this NSSAI.

Must be a string.

Usage Guidelines

Use this command to configure the list of actual DNN profile names.

paginate

Configures whether or not to paginate CLI command output.

Privilege Level

Security Administrator, Administrator

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.

pcscf mark-online

Marks the failed P-CSCF addresses online.

Command Mode

Exec

Syntax

pcscf mark-online [ all | fqdn fqdn  | mw-ipv4 IPv4_address | mw-ipv6  IPv6_address ] 

pcscf mark-online

Allows marking the failed P-CSCF address online. It has four possible values:

  • all — This command marks all the P-CSCF addresses online.

  • fqdn fqdn — This command specifies the FQDN to mark online.

  • mw-ipv4 IPv4_address — This command specifies the failed P-CSCF IPv4 address to mark online.

  • | mw-ipv6 IPv6_address — This command specifies the failed P-CSCF IPv6 address to mark online.

Usage Guidelines

Use this command to activate the failed P-CSCF addresses.

peers all

Displays the peer configuration information.

Command Mode

Exec

Syntax

show peers [ all ] 

Usage Guidelines

Use this command to view peer configuration information.

policy

Configures the policy for PCF interaction or the N7 optimization.

Syntax

policy [ local | optimized ] rat-type [ nr | wlan | eutra ]    

[local|optimized]

policy [ local | optimized ]

Specify the policy.

Must be one of the following:

  • local

  • optimized


Note


In case you configure both policy local and policy optimized together, then policy local takes the precendence.


rat-type [ nr | wlan | eutra ]

Specify the RAT type.

Must be one of the following:

  • nr

  • wlan

  • eutra


Note


This keyword is optional. If rat-type is not configured then the policy local or policy optimized is valid for all the three RAT types, which are NR, WLAN, and EUTRA.


Usage Guidelines

Use this command to configure the policy for PCF interaction or the N7 optimization.

policy actionmgmt

This configuration adds action definition policies.

Command Mode

Exec > Global Configuration (config)

Syntax

policy actionmgmt policy_actionmgmt_name { actiondef actiondef_name { priority priority_number action action_name [ attributes { rulebase rulebase_name [ rules rules_name ] } ] 

actionmgmt policy_actionmgmt_name

Configures the action to be executed.

actiondef actiondef_name

Defines the action attributes to be executed. Currently, it supports only activate-rulebase as the action. For sematic and syntactic error handling, it supports release-session , release-flow , and release-flow-ho as actions.

priority priority_number

Defines the priority in which the actions are to be executed.

action action_name

Defines the actions associated with an actiondef in the order of priority.

attributes

Defines the attributes of a particular action. This is an optional command.

rulebase rulebase_name

Defines a collection of protocol rules to match a flow and associated actions to be taken for matching flow.

rules rules_name

Defines a list of rules to be executed.

Usage Guidelines

This configuration is used to add action definition policies.

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.

profile dnn skip-n10-registration

Ignores the UE registration messages towards UDM during the PDU setup and Wi-Fi attach procedures.

Command Mode

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

Syntax

profile dnn dnn_profile_name { skip-n10-registration rat-type [ NR | WIFI | ALL ] } 

skip-n10-registration rat-type [ NR | WIFI | ALL ]

Specify one of the following RAT types to ignore the UDM registration.

  • NR

  • WIFI

  • ALL


Note


When you configure this CLI command, the SMF ignores the UDM registration during session creation in the 5G and Wi-Fi network. The handover between 5G and Wi-Fi fails because ePDG doesn't find the target SMF that was handling the session. If the UE registration fails during 5G or Wi-Fi attach and if the UDM failure handling template (FHT) is configured as continue or ignore, then SMF reattempts the registration during Wi-Fi-to 5G and 5G to Wi-Fi handovers.


Usage Guidelines

Use this command to ignore the UDM registration messages during the PDU setup and Wi-Fi attach procedures.

policy eventmgmt

Configures the event management policies and defines the attributes.

Command Modes

Exec > Global Configuration (config)

Syntax

policy eventmgmt policy_eventmgmt_name { priority  event_priority [ event event_name ] } 

eventmgmt policy_eventmgmt_name

Configures the event management policies and attributes.

priority event_priority

Defines the priority of a particular event management policy.

event event_name

Defines an event for which a particular action is to be performed. It supports only new-call as the event name. For sematic and syntactic error handling, it supports n1-modify , cbr-resp , and ubr-resp event names.

ruledef ruledef_name

Defines a rule for a local policy that when matched an action is performed.

actiondef actiondef_name

Configures the action name to be executed.

Usage Guidelines

This configuration is used for adding the event management policy.

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-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 rulemgmt

This configuration allows adding rule definition policies.

Command Mode

Exec > Global Configuration (config)

Syntax

policy rulemgmt policy_rulemgmt_name { ruledef rule_def condition condition_string } 

rulemgmt policy_rulemgmt_name

Defines a rule to be added in the policies.

ruledef rule_def

Configures a rule attributes. A ruledef is declared when the conditions match.

condition condition_string

Defines the use cases for a rule. It only supports any condition. For sematic and syntactic error handling, it supports cause-value matches and cause-source matches conditions.

Usage Guidelines

This configuration allows adding rule definition policies.

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   | instance-start-range instance_start_range | instance-stop-range instance_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).

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

sst slice_service_type

Specify the Slice/Service Type (SST).

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

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.

instance-start-range instance_start_range

Specify the SMF instance start range for the DNN profile selection. Must be an integer in the range of 1 to 8.

instance-stop-range instance_stop_range

Specify the SMF instance stop range for the DNN profile selection. Must be an integer in the range of 1 to 8.

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).

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

mnc mobile_network_code

Specify the Mobile Network Code (MNC).

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

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.

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

mnc-list mnc_list

Specify the MNC list.

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

mnc mobile_network_code

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

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

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 access

Configures the access profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile access access_profile_name 

access access_profile_name

Specify name of the access profile.

Must be a string.

Usage Guidelines

Use this command to configure the access profile.

profile access eps-fallback cbr

Configures Create Dedicated Bearer parameters.

Command Mode

Exec > Global Configuration (config) > Access Profile Configuration (config-access-profile_name )

Syntax

eps-fallback cbr delay delay_duration max-retry max_retry timeout timeout_interval 

delay delay_duration

Specify the Create Dedicated Bearer delay duration in milliseconds.

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

Default Value: 0.

max-retry max_retry

Specify the Create Dedicated Bearer maximum retry count.

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

Default Value: 0.

timeout timeout_interval

Specify the Create Dedicated Bearer Retry interval in seconds.

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

Default Value: 1.

Usage Guidelines

Use this command to configure Create Dedicated Bearer parameters.

profile access eps-fallback guard

Configures handling EPS fallback expiry.

Command Mode

Exec > Global Configuration (config) > Access Profile Configuration (config-access-profile_name )

Syntax

eps-fallback guard timeout eps_fallback_timer 

timeout eps_fallback_timer

Specify the EPS fallback guard timer in milliseconds.

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

Default Value: 10000.

Usage Guidelines

Use this command to configure handling EPS fallback expiry.

profile access eps-fallback trigger-cause group

Configures the cause to trigger EPSFallback.

Command Mode

Exec > Global Configuration (config)

Syntax

trigger-cause group cause-group cause_group value cause_types 

cause-group cause_group

Specify the cause group.

Must be one of the following:

  • misc

  • nas

  • protocol

  • radioNetwork

  • transport

value cause_types

Specify the list of cause types for which EPSFallback can be triggered.

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

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

Usage Guidelines

Use this command to configure the cause to trigger EPSFallback.

profile access erir

Configures the ERIR parameters.

Command Mode

Exec > Global Configuration (config) > Access Profile Configuration (config-access-profile_name )

Syntax

erir delay erir_delay 

delay erir_delay

Specify the ERIR delay duration for 4G/WIFI sessions in milliseconds.

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

Default Value: 0.

Usage Guidelines

Use this command to configure the ERIR parameters.

profile access gtpc

Configures the GTPC Failure Handling profile.

Command Mode

Exec > Global Configuration (config) > Access Profile Configuration (config-access-profile_name )

Syntax

gtpc { class-map-cause-profile profile_name | gtpc-failure-profile profile_name } 

class-map-cause-profile profile_name

Specify name of the Class Map Cause profile.

Must be a string.

gtpc-failure-profile profile_name

Specify name of the GTPC Failure Handling profile.

Usage Guidelines

Use this command to configure the GTPC Failure Handling profile.

profile access gtpc message-handling create-session-request ho-ind

Configures handling of Create Session Request received with HO Indicator.

Command Mode

Exec > Global Configuration (config) > Access Profile Configuration (config-access-profile_name )

Syntax

gtpc message-handling create-session-request ho-ind [ new-call-reject ] 

create-session-request ho-ind new-call-reject

Specify to reject Create Session Request received with HO Indicator, if session is not present.

Usage Guidelines

Use this command to configure handling of Create Session Request received with HO Indicator.

profile access gtpc message-handling create-session-response action

Configures action for GTPC message.

Command Mode

Exec > Global Configuration (config) > Access Profile Configuration (config-access-profile_name )

Syntax

gtpc message-handling create-session-response action [ apn-ambr ] 

apn-ambr

Specify APN Aggregate Maximum Bit Rate (APN-AMBR).

Usage Guidelines

Use this command to configure action for GTPC message.

profile access gtpc message-handling create-session-response condition

Configures IP Exhaust condition.

Command Mode

Exec > Global Configuration (config) > Access Profile Configuration (config-access-profile_name )

Syntax

n1 message-handling pdu-establishment condition [ ip-exhaust [ action action [ cause cause_in_response ] ] ] 

action action

Specify the action.

Must be one of the following:

  • backoff

cause cause_in_response

Specify the cause in response. Check the specification for the integer value.

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

Default Value: 0.

ip-exhaust

Specify the IP exhaust condition.

Usage Guidelines

Use this command to configure IP Exhaust condition.

profile access n1 message-handling pdu-establishment condition

Configures IP Exhaust condition.

Command Mode

Exec > Global Configuration (config) > Access Profile Configuration (config-access-profile_name )

Syntax

gtpc message-handling create-session-response condition [ ip-exhaust [ action action [ cause cause_in_response ] ] ] 

action action

Specify the action.

Must be one of the following:

  • backoff

cause cause_in_response

Specify the cause in response. Check the specification for the integer value.

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

Default Value: 0.

ip-exhaust

Specify the IP exhaust condition.

Usage Guidelines

Use this command to configure IP Exhaust condition.

profile access n1 message-handling pdu-release condition

Configures N4 Path Fail condition.

Command Mode

Exec > Global Configuration (config) > Access Profile Configuration (config-access-profile_name )

Syntax

n1 message-handling pdu-release condition [ n4-pathfail [ action action [ cause cause_in_response ] ] ] 

action action

Specify the action.

Must be one of the following:

  • backoff

cause cause_in_response

Specify the cause in response. Check the specification for the integer value.

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

n4-pathfail

Specify the N4 Path Fail condition.

Usage Guidelines

Use this command to configure N4 Path Fail condition.

profile access n1 t3591-pdu-mod-cmd

Configures the N1 timer t3591 - PDU Session Modify Command Retransmission Timer.

Command Mode

Exec > Global Configuration (config) > Access Profile Configuration (config-access-profile_name )

Syntax

n1 t3591-pdu-mod-cmd timeout timeout_period max-retry max_retries 

max-retry max_retries

Specify the PDU Modify Command maximum retry count.

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

Default Value: 2.

timeout timeout_period

Specify the PDU Modify Command timer in seconds.

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

Default Value: 2.

Usage Guidelines

Use this command to configure the n1 timer t3591 - PDU Session Modify Command Retransmission Timer.

profile access n1 t3592-pdu-rel-cmd

Configures the N1 timer t3592 - PDU Sess Rel Command retransmission timer for cause 39 - retransmission required.

Command Mode

Exec > Global Configuration (config) > Access Profile Configuration (config-access-profile_name )

Syntax

n1 t3592-pdu-rel-cmd timeout timeout max-retry max_retry 

max-retry max_retry

Specify the PDU Release Command Max Retry Count.

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

Default Value: 4.

timeout timeout

Specify the PDU Release Command timer in seconds for cause 39.

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

Default Value: 4.

Usage Guidelines

Use this command to configure the n1 timer t3592 - PDU Sess Rel Command retransmission timer for cause 39 - retransmission required.

profile access n1

Configures the N1 interface.

Command Mode

Exec > Global Configuration (config) > Access Profile Configuration (config-access-profile_name )

Syntax

n1 n1-failure-profile n1_failure_profile [ class-map-cause-profile class_map_cause_profile ] 

class-map-cause-profile class_map_cause_profile

Specify the class map cause profile.

Must be a string.

n1-failure-profile n1_failure_profile

Specify the N1 failure profile.

Usage Guidelines

Use this command to configure the N1 interface.

profile access n2

Configures the N2 interface.

Command Mode

Exec > Global Configuration (config) > Access Profile Configuration (config-access-profile_name )

Syntax

n2 n2-failure-profile n2_failure_profile [ class-map-cause-profile class_map_cause_profile ] 

class-map-cause-profile class_map_cause_profile

Specify the class map cause profile.

Must be a string.

n2-failure-profile n2_failure_profile

Specify the N2 failure profile.

Usage Guidelines

Use this command to configure the N2 interface.

profile access n11

Configures the N11 interface.

Command Mode

Exec > Global Configuration (config) > Access Profile Configuration (config-access-profile_name )

Syntax

n11 n11-failure-profile n11_failure_profile [ class-map-cause-profile class_map_cause_profile ] 

class-map-cause-profile class_map_cause_profile

Specify the class map cause profile.

Must be a string.

n11-failure-profile n11_failure_profile

Specify the N11 failure profile.

Usage Guidelines

Use this command to configure the N11 interface.

profile access n2 idft

Configures N2 or N26 Indirect Data Forwarding Tunnel (IDFT) support.

Command Mode

Exec > Global Configuration (config) > Access Profile Configuration (config-access-profile_name )

Syntax

n2 idft enable timeout idft_timeout 

Syntax

n26 idft enable timeout idft_timeout 

enable

Specify to enable IDFT support.

timeout idft_timeout

Specify the IDFT timeout period in seconds.

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

Usage Guidelines

Use this command to configure N2 or N26 IDFT support.

profile access n26 idft

Configures N2 or N26 Indirect Data Forwarding Tunnel (IDFT) support.

Command Mode

Exec > Global Configuration (config) > Access Profile Configuration (config-access-profile_name )

Syntax

n2 idft enable timeout idft_timeout 

Syntax

n26 idft enable timeout idft_timeout 

enable

Specify to enable IDFT support.

timeout idft_timeout

Specify the IDFT timeout period in seconds.

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

Usage Guidelines

Use this command to configure N2 or N26 IDFT support.

profile charging

Configures the charging profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile charging profile_name [ max-charging-condition max_changes | max-deferred-urr max_deferred_urr | max-secondary-rat-reports max_secondary_rat_reports | metering-method metering_method | method charging_method | offline-interim-timer timer_duration | ooo-retry-interval ooo_report_retry_interval | query-all-urr { false | true } | tight-interworking-mode { false | true } ] 

charging profile_name

Specify the charging profile configuration.

Must be a string.

max-charging-condition max_changes

Specify the maximum number of charging condition changes.

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

Default Value: 20.

max-deferred-urr max_deferred_urr

Specify the maximum number of deferred USU containers.

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

Default Value: 50.

max-secondary-rat-reports max_secondary_rat_reports

Specify the maximum number of secondaryRatDataUsageReports to trigger CHF update.

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

Default Value: 0.

metering-method metering_method

Specify the parameters to be metered.

Must be one of the following:

  • duration-volume

  • duration

  • volume

Default Value: duration-volume.

method charging_method

Specify the charging method. Default Value: offline.

Must be one of the following:

  • none

  • offline

  • online

offline-interim-timer timer_duration

Specify the offline interim timer duration in seconds.

Must be an integer.

Default Value: 60.

ooo-retry-interval ooo_report_retry_interval

Specify the interval, in milliseconds, at which OOO report will be retried.

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

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

query-all-urr { false | true }

Specify to enable or disable query all URRs.

Must be one of the following:

  • false

  • true

Default Value: true.

tight-interworking-mode { false | true }

Specify to enable or disable tight interworking mode for online/offline charging methods.

Must be one of the following:

  • false

  • true

Default Value: false.

Usage Guidelines

Use this command to configure the charging profile.

profile charging accounting limit

Configures the duration threshold for accounting.

Command Mode

Exec > Global Configuration (config) > Charging Profile Configuration (config-charging-profile_name )

Syntax

accounting limit duration threshold 

duration threshold

Specify the duration threshold for accounting.

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

Usage Guidelines

Use this command to configure the duration threshold for accounting.

profile charging accounting limit volume

Configures the volume threshold for accounting.

Command Mode

Exec > Global Configuration (config) > Charging Profile Configuration (config-charging-profile_name )

Syntax

accounting limit volume { downlink downlink_volume_limit | total total_volume_limit | uplink uplink_volume_limit } 

downlink downlink_volume_limit

Specify the downlink volume limit in bytes for interim generation.

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

total total_volume_limit

Specify the total volume limit in bytes for interim generation.

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

uplink uplink_volume_limit

Specify the uplink volume limit in bytes for interim generation.

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

Usage Guidelines

Use this command to configure the volume threshold for accounting.

profile charging dynamic-rules request-quota

Configures the dynamic rules request quota.

Command Mode

Exec > Global Configuration (config) > Charging Profile Configuration (config-charging-profile_name )

Syntax

dynamic-rules request-quota { on-receiving-rule | on-traffic-match } 

on-receiving-rule

Specify this value to send CCR-I message with RSU on receiving the dynamic rule.

on-traffic-match

Specify this value to send CCR-I message with RSU on receiving the start of traffic.

Default Value: on-receiving-rule .

Usage Guidelines

Use this command to configure dynamic rules request quota.

profile charging failure-handling error-type

Configures the failure handling error type for Rating Group-level and application-level errors.

Command Mode

Exec > Global Configuration (config) > Charging Profile Configuration (config-charging-profile_name )

Syntax

failure-handling error-type [ rg | app ] error-value error_value action action_value 

failure-handling error-type [ rg | app ]

Specify this value to configure the failure handling error type as Rating Group or Application.

error-value error_value action action_value

For the application-level errors, specify one of the following values for action_value

  • drop-data —Specify this value to drop data corresponding to the charging ID.

  • terminate —Specify this value to release the PDU session.

  • continue —Specify this value to disable charging.

For the Rating Group-level errors, enter one of the following values for action_value :

  • convert-offline —Specify this value to convert to offline charging.

  • delete-flow —Specify this value to delete the flow or rule associated with the Rating Group.

  • drop-data —Specify this value to drop data corresponding to the Rating Group.

  • terminate —Specify this value to release the PDU session.


Note


  • If you haven't configured an action for the Rating Group-level and application-level errors, the SMF continues with the default behavior.

  • SMF doesn’t allow mapping of multiple QoS flows to the same Rating Group for dynamic rules.

  • The drop-data action is applicable to all the flows that are associated to the Rating Group.


Usage Guidelines

Use this command to configure failure handling error type for Rating Group-level and application-level errors.

profile charging limit

Configures the duration and volume thresholds.

Command Mode

Exec > Global Configuration (config) > Charging Profile Configuration (config-charging-profile_name )

Syntax

limit { duration duration_threshold | volume volume_threshold } 

duration duration_threshold

Specify the duration threshold for charging.

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

volume volume_threshold

Specify the volume threshold for charging.

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

Usage Guidelines

Use this command to configure the duration and volume thresholds.

profile charging limit rating-group

Configures the rating group volume and duration thresholds.

Command Mode

Exec > Global Configuration (config) > Charging Profile Configuration (config-charging-profile_name )

Syntax

limit rating-group { duration duration_threshold | volume volume_threshold } 

duration duration_threshold

Specify the duration threshold for charging.

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

volume volume_threshold

Specify the volume threshold for charging.

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

Usage Guidelines

Use this command to configure the rating group duration and volume thresholds.

profile charging mscc-final-unit-action terminate session

Terminates the session when MSCC final unit action is terminate.

.

Command Mode

Exec > Global Configuration (config) > Charging Profile Configuration (config-charging-profile_name )

Syntax

mscc-final-unit-action terminate session 

mscc-final-unit-action terminate session

Terminate the session when MSCC final unit action is terminate.

Usage Guidelines

Use this command to terminate the session when the MSCC final unit action is terminate.

profile charging offline zero-usage

Configures offline charging zero-usage parameters.

Command Mode

Exec > Global Configuration (config) > Charging Profile Configuration (config-charging-profile_name )

Syntax

offline zero-usage [ drop suppress_for_zero_usage | measurement parameters_to_suppress | trigger triggers_to_suppress ] 

drop suppress_for_zero_usage

Specify the parameters to suppress for zero usage.

Must be one of the following:

  • cdr

  • uuc

measurement parameters_to_suppress

Specify the parameters to be suppressed.

Must be one of the following:

  • duration

  • volume

trigger triggers_to_suppress

Specify the list of triggers to be suppressed.

Must be one of the following:

  • external

  • final

  • internal

Usage Guidelines

Use this command to configure offline charging zero-usage parameters.

profile charging quota

Configures the charging quota parameters.

Command Mode

Exec > Global Configuration (config) > Charging Profile Configuration (config-charging-profile_name )

Syntax

quota request request_quota 

request request_quota

Specify the request quota from CHF.

Must be one of the following:

  • always

  • standard

Default Value: standard.

Usage Guidelines

Use this command to configure the charging quota parameters.

profile charging quota suppress

Configures the list of triggers to be suppressed.

Command Mode

Exec > Global Configuration (config) > Charging Profile Configuration (config-charging-profile_name )

Syntax

quota suppress triggers triggers_to_suppress 

triggers triggers_to_suppress

Specify the list of triggers to be suppressed.

Must be one of the following:

  • qht

Usage Guidelines

Use this command to configure the list of triggers to be suppressed.

profile charging quota validity-time

Configures the validity lifetime of the quota.

Command Mode

Exec > Global Configuration (config) > Charging Profile Configuration (config-charging-profile_name )

Syntax

quota validity-time validity_time 

validity-time validity-time

Specify the validity lifetime of the quota.

Must be an integer in the range of 1 through 4000000 seconds.

Usage Guidelines

Use this command to configure the charging validity lifetime of the quota.

profile charging quota volume-threshold percent

Configures the volume threshold value as a percentage of the volume quota.

Command Mode

Exec > Global Configuration (config) > Charging Profile Configuration (config-charging-profile_name )

Syntax

quota volume-threshold percent  volume-threshold percent 

volume-threshold percent volume-threshold percent

Specify the volume threshold value as a percentage of the volume quota.

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

Usage Guidelines

Use this command to configure the charging volume threshold value as a percentage of the volume quota.

profile charging reporting-level

Configures the usage reporting level to be used if not sent by the PCF.

Command Mode

Exec > Global Configuration (config) > Charging Profile Configuration (config-charging-profile_name )

Syntax

reporting-level { offline reporting_level | online reporting_level } 

offline reporting_level

Specify the reporting level configuration for offline.

Must be one of the following:

  • rating-group

  • service-id

Default Value: rating-group.

online reporting_level

Specify the reporting level configuration for online.

Must be one of the following:

  • rating-group

  • service-id

Default Value: rating-group.

Usage Guidelines

Use this command to configure the usage reporting level to be used if not sent by the PCF.

profile charging requested-service-unit

Configures the Requested Service Unit time parameter.

Command Mode

Exec > Global Configuration (config) > Charging Profile Configuration (config-charging-profile_name )

Syntax

requested-service-unit time rsu_time 

time rsu_time

Specify the Requested Service Unit time value in seconds.

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

Usage Guidelines

Use this command to configure the Requested Service Unit time parameter.

profile charging requested-service-unit volume

Configures the Requested Service Unit Volume parameters.

Command Mode

Exec > Global Configuration (config) > Charging Profile Configuration (config-charging-profile_name )

Syntax

requested-service-unit volume { uplink uplink_volume | downlink downlink_volume | total total_volume } 

downlink downlink_volume

Specify the downlink volume in bytes.

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

total total_volume

Specify the total volume in bytes.

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

uplink uplink_volume

Specify the uplink volume in bytes.

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

Usage Guidelines

Use this command to configure the Requested Service Unit Volume parameters.

profile charging send charging-initial

Configures the option to send CCR-I message towards OCS when dynamic and predefined rules are received or when the usage report is received with the start of traffic.

Command Mode

Exec > Global Configuration (config) > Charging Profile Configuration (config-charging-profile_name )

Syntax

send charging-initial { session-start | traffic-start } 

session-start

Specify whether to send CCR-I message towards OCS on receiving the dynamic and predefined rules.

traffic-start

Specify whether to send the CCR-I message towards OCS on receiving the usage report with the start of traffic.

The default value is session-start .

Usage Guidelines

Use this command to configure an option for sending CCR-I message towards OCS when dynamic and predefined rules are received or when the usage report is received with the start of traffic.

profile charging session-failover

Configure the Diameter session failover for the Gy interface.

Command Mode

Exec > Global Configuration (config) > Charging Profile Configuration (config-charging-profile_name )

Syntax

session-failover { false | true } 

false

Disable the Diameter session failover for Gy.

true

Enable the Diameter session failover for Gy.

Default Value: false

Usage Guidelines

Use this command to configure Diameter session failover for Gy.

profile charging tariff-time-change

Configures timestamps for tariff-time change.

Command Mode

Exec > Global Configuration (config) > Charging Profile Configuration (config-charging-profile_name )

Syntax

tariff-time-change { hour hour | minute minute } 

hour hour

Specify the hour timestamp for tariff-time change.

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

minute minute

Specify the minute timestamp for tariff-time change.

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

Usage Guidelines

Use this command to configure timestamps for tariff-time change.

profile charging triggers

Configures the list of triggers.

Command Mode

Exec > Global Configuration (config) > Charging Profile Configuration (config-charging-profile_name )

Syntax

triggers session triggers 

session triggers

Specify the list of session-level triggers.

Must be one of the following:

  • 3gpp-ps-change

  • ambr-change

  • max-number-of-changes-in-charging-conditions

  • plmn-change

  • qos-change

  • rat-change

  • serv-node-change

  • tarrif-time-change

  • ue-pra-change

  • ue-time-change

  • upf-add

  • upf-rem

  • user-loc-change

Usage Guidelines

Use this command to configure the list of triggers.

profile charging-characteristics

Configures the charging characteristics profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile charging-characteristics cc_profile_name [ [ charging-profile charging_profile_name ] [ charging-qbc-profile charging_qbc_profile_name ] ] 

charging-characteristics cc_profile_name

Specify name of the charging characteristics profile. For example, 1, 2, 3, 12, 14, till 16.

Must be a string of 1-2 characters in the pattern '[0-9]*'.

charging-profile charging_profile_name

Specify name of the Charging profile.

Must be a string.

charging-qbc-profile charging_qbc_profile_name

Specify name of the Charging QBC profile.

Must be a string.

Usage Guidelines

Use this command to configure the charging characteristics profile.

profile charging-characteristics network-element-profile-list

Configures the network elements profile list.

Command Mode

Exec > Global Configuration (config) > Charging Characteristics Profile Configuration (config-charging-characteristics-profile_name )

Syntax

network-element-profile-list chf charging_server 

chf charging_server

Specify the list of charging servers.

Must be a string.

Usage Guidelines

Use this command to configure the network elements profile list.

profile charging-qbc

Configures the Charging QBC profile.

Command Mode

Exec > Global Configuration (config) > Charging Characteristics Profile Configuration (config-charging-characteristics-profile_name )

Syntax

charging-qbc charging_qbc_profile_name [ [ max-charging-condition max_charging_condition_changes ] [ max-deferred-urr max_deferred_urr ] [ ooo-retry-interval ooo_report_retry_interval ] [ triggers bearer_level_triggers ] ] 

charging-qbc charging_qbc_profile_name

Specify name of the Charging QBC profile.

Must be a string.

max-charging-condition max_charging_condition_changes

Specify the maximum number of charging condition changes.

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

Default Value: 20.

max-deferred-urr max_deferred_urr

Specify the maximum number of deferred USU containers.

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

Default Value: 50.

ooo-retry-interval ooo_report_retry_interval

Specify the list intervals at which OOO report will be retried in miliseconds. Default: 5 50 2000.

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

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

triggers bearer_level_triggers

Specify the list of bearer level triggers.

Must be one of the following:

  • 3gpp-ps-change

  • ambr-change

  • max-number-of-changes-in-charging-conditions

  • plmn-change

  • qos-change

  • rat-change

  • serv-node-change

  • tarrif-time-change

  • ue-pra-change

  • ue-time-change

  • upf-add

  • upf-rem

  • user-loc-change

Usage Guidelines

Use this command to configure the Charging QBC profile.

profile charging-qbc limit

Configures the thresholds.

Command Mode

Exec > Global Configuration (config) > Charging Characteristics Profile Configuration (config-charging-characteristics-profile_name )

Syntax

limit { duration duration_threshold | volume volume_threshold } 

duration duration_threshold

Specify the duration threshold for charging.

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

volume volume_threshold

Specify the volume threshold for charging.

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

Usage Guidelines

Use this command to configure the thresholds.

profile charging usage-reporting quota-to-report based-on-grant

Configures the charging usage reporting quota to report volume or duration in Used Service Unit to OCS if it is granted in Granted Service Unit by OCS server.

Command Mode

Exec > Global Configuration (config) > Charging Profile Configuration (config-charging-profile_name )

Syntax

usage-reporting quota-to-report based-on-grant { report-only-granted-volume } 

quota-to-report based-on-grant {report-only-granted-volume}

The based-on-grant option specifies the report volume or duration in Used Service Unit to OCS if only it is granted in Granted Service Unit by OCS server. The report-only-granted-volume option specifies the filter for sending Used Volume quota to OCS base on Input, Output, or Total Octets granted in Granted Service Unit by OCS server.

Usage Guidelines

Use this command to configure the charging usage reporting quota to report volume or duration in Used Service Unit to OCS if it is granted in Granted Service Unit by OCS server.

profile compliance

Configures 3GPP compliance configuration.

Command Mode

Exec > Global Configuration (config)

Syntax

compliance profile_name 

compliance profile_name

Specify name of the compliance profile.

Must be a string.

Usage Guidelines

Use this command to configure the 3GPP compliance configuration.

profile compliance service

Configures the SMF service names.

Command Mode

Exec > Global Configuration (config) > Compliance Profile Configuration (config-compliance-profile_name )

Syntax

service service_name 

service_name

Specify the service names.

Must be one of the following:

  • n1

  • n2

  • namf-comm

  • nchf-convergedcharging

  • nnrf-disc

  • nnrf-nfm

  • npcf-smpolicycontrol

  • nsmf-pdusession

  • nudm-sdm

  • nudm-uecm

  • threegpp23502

Usage Guidelines

Use this command to configure the SMF service names. The service names are specified in 3GPPTS 29.510 V15.2.0, Section 6.1.6.3.11.

profile compliance service n1

Configures the 3GPP n1 specification version number.

Command Mode

Exec > Global Configuration (config) > Compliance Profile Configuration (config-compliance-profile_name )

Syntax

service n1 version { full full_version | spec 3gpp_spec_version | uri version_uri } | version-list version version_name { full full_version | mode { active | offline } | spec 3gpp_spec_version | uri version_uri } 

version

Specify the 3GPP compliance version to configure. It allows only one compliance version to be configured at a time.

full full_version

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

Must be a string in the pattern '\d+.\d+.\d+^?(.alpha-\d+)?'.

spec 3gpp_spec_version

Specify the 3GPP N1 specification version number.

Must be one of the following:

  • 15.2.0

  • 15.4.0

Default Value: 15.2.0.

uri version_uri

Specify the version URI.

Must be a string in the pattern 'v\d'.

version-list version version_name

Specify the 3GPP compliance versions to configure. It allows a maximum of two compliance versions to be configured at a time.

mode { active | offline }

Specify the status of configured 3GPP compliance versions. mode is an optional configuration. The default value is active . If version-list version is configured with two versions, then at least one version should be active .

Usage Guidelines

Use this command to configure the 3GPP n1 specification version number.

profile compliance service n2

Configures the 3GPP n2 service specification version number.

Command Mode

Exec > Global Configuration (config) > Compliance Profile Configuration (config-compliance-profile_name )

Syntax

service n2 version { full full_version | spec 3gpp_spec_version | uri version_uri } | version-list version version_name { full full_version | mode { active | offline } | spec 3gpp_spec_version | uri version_uri } 

version

Specify the 3GPP compliance version to configure. It allows only one compliance version to be configured at a time.

full full_version

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

Must be a string in the pattern '\d+.\d+.\d+^?(.alpha-\d+)?'.

spec 3gpp_spec_version

Specify the 3GPP n2 service specification version number.

Must be one of the following:

  • 15.0.0

  • 15.2.0

  • 15.4.0

Default Value: 15.0.0.

uri version_uri

Specify the version URI.

Must be a string in the pattern 'v\d'.

version-list version version_name

Specify the 3GPP compliance versions to configure. It allows a maximum of two compliance versions to be configured at a time.

mode { active | offline }

Specify the status of configured 3GPP compliance versions. mode is an optional configuration. The default value is active . If version-list version is configured with two versions, then at least one version should be active .

Usage Guidelines

Use this command to configure the 3GPP N2 service specification version number.

profile compliance service namf-comm

Configures the 3GPP namf-comm specification version number.

Command Mode

Exec > Global Configuration (config) > Compliance Profile Configuration (config-compliance-profile_name )

Syntax

service namf-comm version { full full_version | spec 3gpp_spec_version | uri version_uri } | version-list version version_name { full full_version | mode { active | offline } | spec 3gpp_spec_version | uri version_uri } 

version

Specify the 3GPP compliance version to configure. It allows only one compliance version to be configured at a time.

full full_version

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

Must be a string in the pattern '\d+.\d+.\d+^?(.alpha-\d+)?'.

spec 3gpp_spec_version

Specify the 3GPP namf-comm specification version number.

Must be one of the following:

  • 15.0.0

  • 15.2.0

  • 15.4.0

Default Value: 15.0.0.

uri version_uri

Specify the version URI.

Must be a string in the pattern 'v\d'.

version-list version version_name

Specify the 3GPP compliance versions to configure. It allows a maximum of two compliance versions to be configured at a time.

mode { active | offline }

Specify the status of configured 3GPP compliance versions. mode is an optional configuration. The default value is active . If version-list version is configured with two versions, then at least one version should be active .

Usage Guidelines

Use this command to configure the 3GPP namf-comm specification version number.

profile compliance service nchf-convergedcharging

Configures the 3GPP nchf-convergedcharging service specification version number.

Command Mode

Exec > Global Configuration (config) > Compliance Profile Configuration (config-compliance-profile_name )

Syntax

service nchf-convergedcharging version { full full_version | spec 3gpp_spec_version | uri version_uri } | version-list version version_name { full full_version | mode { active | offline } | spec 3gpp_spec_version | uri version_uri } 

version

Specify the 3GPP compliance version to configure. It allows only one compliance version to be configured at a time.

full full_version

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

Must be a string in the pattern '\d+.\d+.\d+^?(.alpha-\d+)?'.

spec 3gpp_spec_version

Specify the 3GPP nchf-convergedcharging service specification version number.

Must be one of the following:

  • 15.0.0

  • 15.1.0

  • 15.2.1

  • 15.3.0.std

  • 15.3.0

Default Value: 15.0.0.

uri version_uri

Specify the version URI.

Must be a string in the pattern 'v\d'.

version-list version version_name

Specify the 3GPP compliance versions to configure. It allows a maximum of two compliance versions to be configured at a time.

mode { active | offline }

Specify the status of configured 3GPP compliance versions. mode is an optional configuration. The default value is active . If version-list version is configured with two versions, then at least one version should be active .

Usage Guidelines

Use this command to configure the 3GPP nchf-convergedcharging service specification version number.

profile compliance service nnrf-disc

Configures the 3GPP nnrf-disc service specification version number.

Command Mode

Exec > Global Configuration (config) > Compliance Profile Configuration (config-compliance-profile_name )

Syntax

service nnrf-disc version { full full_version | spec 3gpp_spec_version | uri version_uri } | version-list version version_name { full full_version | mode { active | offline } | spec 3gpp_spec_version | uri version_uri } 

version

Specify the 3GPP compliance version to configure. It allows only one compliance version to be configured at a time.

full full_version

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

Must be a string in the pattern '\d+.\d+.\d+^?(.alpha-\d+)?'.

spec 3gpp_spec_version

Specify the 3GPP nnrf-disc service specification version number.

Must be one of the following:

  • 15.0.0

  • 15.2.0

  • 15.4.0

Default Value: 15.2.0.

uri version_uri

Specify the version URI.

Must be a string in the pattern 'v\d'.

version-list version version_name

Specify the 3GPP compliance versions to configure. It allows a maximum of two compliance versions to be configured at a time.

mode { active | offline }

Specify the status of configured 3GPP compliance versions. mode is an optional configuration. The default value is active . If version-list version is configured with two versions, then at least one version should be active .

Usage Guidelines

Use this command to configure the 3GPP nnrf-disc service specification version number.

profile compliance service nnrf-nfm

Configures the 3GPP nnrf-nfm service specification version number.

Command Mode

Exec > Global Configuration (config) > Compliance Profile Configuration (config-compliance-profile_name )

Syntax

service nnrf-nfm version { full full_version | spec 3gpp_spec_version | uri version_uri } | version-list version version_name { full full_version | mode { active | offline } | spec 3gpp_spec_version | uri version_uri } 

version

Specify the 3GPP compliance version to configure. It allows only one compliance version to be configured at a time.

full full_version

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

Must be a string in the pattern '\d+.\d+.\d+^?(.alpha-\d+)?'.

spec 3gpp_spec_version

Specify the 3GPP nnrf-nfm service specification version number.

Must be one of the following:

  • 15.0.0

  • 15.2.0

  • 15.4.0

Default Value: 15.2.0.

uri version_uri

Specify the version URI.

Must be a string in the pattern 'v\d'.

version-list version version_name

Specify the 3GPP compliance versions to configure. It allows a maximum of two compliance versions to be configured at a time.

mode { active | offline }

Specify the status of configured 3GPP compliance versions. mode is an optional configuration. The default value is active . If version-list version is configured with two versions, then at least one version should be active .

Usage Guidelines

Use this command to configure the 3GPP nnrf-nfm service specification version number.

profile compliance service npcf-smpolicycontrol

Configures the 3GPP npcf-smpolicycontrol service specification version number.

Command Mode

Exec > Global Configuration (config) > Compliance Profile Configuration (config-compliance-profile_name )

Syntax

service npcf-smpolicycontrol version { full full_version | spec 3gpp_spec_version | uri version_uri } | version-list version version_name { full full_version | mode { active | offline } | spec 3gpp_spec_version | uri version_uri } 

version

Specify the 3GPP compliance version to configure. It allows only one compliance version to be configured at a time.

full full_version

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

Must be a string in the pattern '\d+.\d+.\d+^?(.alpha-\d+)?'.

spec 3gpp_spec_version

Specify the 3GPP npcf-smpolicycontrol service specification version number.

Must be one of the following:

  • 15.0.0

  • 15.2.0

  • 15.4.0

Default Value: 15.2.0.

uri version_uri

Specify the version URI.

Must be a string in the pattern 'v\d'.

version-list version version_name

Specify the 3GPP compliance versions to configure. It allows a maximum of two compliance versions to be configured at a time.

mode { active | offline }

Specify the status of configured 3GPP compliance versions. mode is an optional configuration. The default value is active . If version-list version is configured with two versions, then at least one version should be active .

Usage Guidelines

Use this command to configure the 3GPP npcf-smpolicycontrol service specification version number.

profile compliance service nsmf-pdusession

Configures the 3GPP nsmf-pdusession specification version number.

Command Mode

Exec > Global Configuration (config) > Compliance Profile Configuration (config-compliance-profile_name )

Syntax

service nsmf-pdusession version { full full_version | spec 3gpp_spec_version | uri version_uri } | version-list version version_name { full full_version | mode { active | offline } | spec 3gpp_spec_version | uri version_uri } 

version

Specify the 3GPP compliance version to configure. It allows only one compliance version to be configured at a time.

full full_version

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

Must be a string in the pattern '\d+.\d+.\d+^?(.alpha-\d+)?'.

spec 3gpp_spec_version

Specify the 3GPP nsmf-pdusession specification version number.

Must be one of the following:

  • 15.0.0

  • 15.2.0

  • 15.4.0

Default Value: 15.0.0.

uri version_uri

Specify the version URI.

Must be a string in the pattern 'v\d'.

version-list version version_name

Specify the 3GPP compliance versions to configure. It allows a maximum of two compliance versions to be configured at a time.

mode { active | offline }

Specify the status of configured 3GPP compliance versions. mode is an optional configuration. The default value is active . If version-list version is configured with two versions, then at least one version should be active .

Usage Guidelines

Use this command to configure the 3GPP nsmf-pdusession specification version number.

profile compliance service nudm-sdm

Configures the 3GPP nudm-sdm service specification version number.

Command Mode

Exec > Global Configuration (config) > Compliance Profile Configuration (config-compliance-profile_name )

Syntax

service nudm-sdm version { full full_version | spec 3gpp_spec_version | uri version_uri } | version-list version version_name { full full_version | mode { active | offline } | spec 3gpp_spec_version | uri version_uri } 

version

Specify the 3GPP compliance version to configure. It allows only one compliance version to be configured at a time.

full full_version

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

Must be a string in the pattern '\d+.\d+.\d+^?(.alpha-\d+)?'.

spec 3gpp_spec_version

Specify the 3GPP nudm-sdm service specification version number.

Must be one of the following:

  • 15.1.0

  • 15.2.1

  • 15.4.0

Default Value: 15.2.1.

uri version_uri

Specify the version URI.

Must be a string in the pattern 'v\d'.

version-list version version_name

Specify the 3GPP compliance versions to configure. It allows a maximum of two compliance versions to be configured at a time.

mode { active | offline }

Specify the status of configured 3GPP compliance versions. mode is an optional configuration. The default value is active . If version-list version is configured with two versions, then at least one version should be active .

Usage Guidelines

Use this command to configure the 3GPP nudm-sdm service specification version number.

profile compliance service nudm-uecm

Configures the 3GPP nudm-uecm service specification version number.

Command Mode

Exec > Global Configuration (config) > Compliance Profile Configuration (config-compliance-profile_name )

Syntax

service nudm-uecm version { full full_version | spec 3gpp_spec_version | uri version_uri } | version-list version version_name { full full_version | mode { active | offline } | spec 3gpp_spec_version | uri version_uri } 

version

Specify the 3GPP compliance version to configure. It allows only one compliance version to be configured at a time.

full full_version

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

Must be a string in the pattern '\d+.\d+.\d+^?(.alpha-\d+)?'.

spec 3gpp_spec_version

Specify the 3GPP nudm-uecm service specification version number.

Must be one of the following:

  • 15.1.0

  • 15.2.1

  • 15.4.0

Default Value: 15.2.1.

uri version_uri

Specify the version URI.

Must be a string in the pattern 'v\d'.

version-list version version_name

Specify the 3GPP compliance versions to configure. It allows a maximum of two compliance versions to be configured at a time.

mode { active | offline }

Specify the status of configured 3GPP compliance versions. mode is an optional configuration. The default value is active . If version-list version is configured with two versions, then at least one version should be active .

Usage Guidelines

Use this command to configure the 3GPP nudm-uecm service specification version number.

profile compliance service threegpp23502

Configures the 3GPP 23.502 Stage-2 5GS specification version number.

Command Mode

Exec > Global Configuration (config) > Compliance Profile Configuration (config-compliance-profile_name )

Syntax

service threegpp23502 version { full full_version | spec 3gpp_spec_version | uri version_uri } 

version

Specify the 3GPP compliance version to configure. It allows only one compliance version to be configured at a time.

full full_version

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

Must be a string in the pattern '\d+.\d+.\d+^?(.alpha-\d+)?'.

spec 3gpp_spec_version

Specify the 3GPP 23.502 Stage-2 5GS specification version number.

Must be one of the following:

  • 15.4.0

  • 15.6.0

Default Value: 15.4.0.

uri version_uri

Specify the version URI.

Must be a string in the pattern 'v\d'.

Usage Guidelines

Use this command to configure the 3GPP 23.502 Stage-2 5GS specification version number.

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.

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


Usage Guidelines

Use this command to enable the supported features for a rolling upgrade.

profile diameter-client

Configures Diameter client.

Command Mode

Exec > Global Configuration (config)

Syntax

profile diameter-client  diameter_client_name [ dictionary-name { dcca-custom8 | default | r8-gx-standard } | endpoint | failure-handling-profile | host-selection | request-timeout ]  

diameter-client diameter_client_name

Specify a Diameter client profile name.

dictionary-name { dcca-custom8 | default | r8-gx-standard }

Specify one of the following dictionaries to be used.

  • dcca-custom8 : This is the standard Gy dictionary.

  • default : This is the default dictionary.

  • r8-gx-standard : This is the standard Gx dictionary.

endpoint

Specify the associated diameter endpoint profile.

failure-handling-profile

Specify the associated diameter failure handling profile.

host-selection

Specify the Diameter host selection profile.

request-timeout

Indicate the time out of the request.

profile diameter-endpoint

Specify a Diameter endpoint on the Gx or Gy interface.

Command Mode

Exec > Global Configuration (config)

Syntax

profile diameter-endpoint interface_name instance instance-id instance_id_value internal-vip ip_address[ destination-host-avp message_type| vsa-support vendorId-source| max-outstanding number_of_messages| response-timeout response_timeout_value| connection-timeout connection-timeout_value| basemsg retransmission-timeout retransmission_timeout_value| basemsg retransmissions max_retry_value| basemsg watchdog-interval interval_value| dscp [ dscp_value | af11 | af12 | af13 | af21 | af22 | af23 | af31 | af32 | af33 | af41 | af42 | af43 | be | cs1 | cs2 | cs3 | cs4 | cs5 | cs6 | cs7 | ef ] | origin realm realm_name| origin host host_name address ipv4 ip_address | origin peer origin_peer_name | realm  realm_name| address ipv4 ip_address| port peer_port| destination-host-name  destination_host_name| load-balancing-algorithm highest-weight| route-entry host [ host-name | * ] realm [ realm-name | * ] peer peer_name weight weight_value| route-failure deadtime deadtime_value result-code result_code_value threshold  number| route-failure result-code result_codes_value| route-failure threshold  threshold_number| route-failure recovery-threshold percent  recovery_threshold_percentage| dynamic-route expiry-timeout  expiry_timeout_value | dynamic-route expiry-timeout  | dynamic-origin-state-id  boolean_value | disconnect peer request| busy time time_duration| do not talk time time_interval| drain time time_interval| reboot time time_duration] 

profile diameter-endpoint interface_name

Specify a Diameter profile for the Gx or Gy interface.

instance instance-id instance_id_value

Specify the value of the instance ID.

internal-vip

Internal VIP IP address. This parameter is mandatory

destination-host-avp message_type

Specify the type of message in which the destination host AVP is to be encoded.


Note


SMF supports always and session-binding values for the message_type .


vsa-support vendorId-source

Specify the source of vendor IDs DIABASE to be used for negotiation of Diameter peer capabilities.


Note


SMF supports only the all-from-dictionary value for the vendorId-source .


max-outstanding number_of_messages

Specify the maximum number of Diameter messages to be sent to any peer in the profile, while awaiting the responses. The default value is 256. number_of_messages must be in the range of 1–4096.

response-timeout response_timeout_value

Specify the maximum allowed response time for request messages that the Diameter applications send to the Diameter server. The default value is 60. response_timeout_value must be in the range of 1–300.

connection-timeout connection-timeout_value

Specify the maximum allowed time for establishing the transport layer connectivity, such as the TCP connection, toward the Diameter server. The default value is 30. connection-timeout_value must be in the range of 1–300.

basemsg retransmission-timeout retransmission_timeout_value

Specify the timeout value between retransmissions of the base messages, such as Device Watchdog Request (DWR) and Capability Exchange Request (CER), toward the Diameter server. The default value is 30.

retransmission_timeout_value must be in the range of 1–120.

basemsg retransmissions max_retry_value

Specify the maximum number of times the base messages must be retransmitted. The default value is 1. max-retries must be in the range of 1–10.

basemsg watchdog-interval interval_value

Specify the time interval between the two DWR messages that are sent toward the Diameter server. The default value is 30. interval_value must be in the range of 6–30.

dscp [ dscp_value| af11 | af12 | af13 | af21 | af22 | af23 | af31 | af32 | af33 | af41 | af42 | af43 | be | cs1 | cs2 | cs3 | cs4 | cs5 | cs6 | cs7 | ef ]

Specify the Differential Services Code Point (DSCP) value in the IP header of the Diameter messages that are sent toward the Diameter server. The default value is be . dscp_value must be in the range of 0–63. Choose in the following other DSCP values, as required:

  • af xx: Specify this value for the use of an assured forwarding xx per hop behavior (PHB).

  • be : Specify this value for the use of best effort forwarding PHB. be is the default value.

  • cs x: Specify this value for the use of class selector x per PHB.

  • ef : Specify this value for the use of expedited forwarding PHB.

origin realm realm_name

Specify the name of the realm for the Diameter endpoint. This parameter is mandatory.

origin host host_name address ipv4 ip_address

Specify the host name, which is the FQDN of the Diameter endpoint. Specify the IPv4 address, which is the Diameter endpoint Bind IP address for the Diameter client connections.

origin peer origin_peer_name

Specify the identifier for a Diameter peer. This parameter is mandatory.

realm realm_name

Specify the name of the realm for a peer with the name of the peer. This parameter is mandatory.

address ipv4 ip_address

Specify the IP address of the Diameter peer.

port peer_port

Specify the port of the Diameter peer. This parameter is mandatory.

destination-host-name destination_host_name

Specify the custom destination host name to be used in destination host AVP. This parameter is optional.

load-balancing-algorithm highest-weight

Choose an idle server with the highest weight in failure scenarios. If multiple servers have the same high weight, then the load balancing happens among those servers.

route-entry host [ host-name | * ] realm [ realm-name | * ] peer peer_name weight weight_value

Use this command to configure two static entries, such as a peer in the route table. If you configure an entry with the existing same flag, host, realm, then only the weight is updated with higher of two of them. The host and realm parameters allow wildcard character values. The weight is an optional parameter with the default value as 10. The peer is a mandatory parameter.


Note


You can configure multiple route entries with the same host and realm but a different peer without being overridden.


route-failure deadtime deadtime_value result-code result_code_value threshold number

Specify the duration in seconds for which the system keeps the route in the FAILED status. After the configured duration expires, the system changes the status to AVAILABLE . deadtime_value must be an integer in the range of 1–86400. The default value is 60.

route-failure result-code result_codes_value

Specify the answer messages that are to be considered as failures, in addition to the requests that time out.


Note


You can specify up to 16 result codes.


route-failure threshold threshold_number

Specify the number of errors that cause the FAILED status. The default value is 16.


Note


The error counter begins at zero. In a case of a good response, the error counter decrements or increments. This counter does not decrement below zero or increment above the configured threshold number.


route-failure recovery-threshold percent recovery_threshold_percentage

Specify the percentage value at which the failure counter is reset when provisionally changing the status from FAILED to AVAILABLE . For example, a failure counter of 16 caused the AVAILABLE status to change to FAILED status. After the configured deadtime expires, the status changes to AVAILABLE . If recovery_threshold_percentage is configured with 75 percent, the failure counter resets to 12, which is 75 percent of 16. The default value is 90.

dynamic-route expiry-timeout expiry_timeout_value

Specify the expiration time for dynamic routes that you created after reaching the Diameter destination host. The default value is 86400 secs, which equals one day.

dynamic-origin-state-id boolean_value

Specify whether you want to enable or disable the dynamic origin state ID. The default value is true.

disconnect peer request

The Disconnect-Peer-Request (DPR) is sent to a peer to inform its intentions to disconnect the connection from the peer nodes.

busy time time_duration

Specify the time duration after which the connection is reattempted to peer. The time duration value must be an integer in the range of 1–300 seconds. The default value is 3 seconds.

do not talk time time_interval

Specify the time interval between receiving of DPR by diameter endpoint and sending of DPA response. The time interval value must be the integer in the range of 1–300 seconds. The default value is 3 seconds.

drain time time_interval

Specify the time interval between receiving of DPR by diameter endpoint and sending of DPA response. The time interval value must be an integer in the range of 1 to 10 seconds. The default value is 3 seconds.

reboot time time_duration

Specify the time duration after which the connection is reattempted to peer. The time duration value must be an integer in the range of 1–300 seconds. The default value is 3 seconds.

profile diameter-host-selection

Configures the data of an individual profile name with algorithm and list of primary and secondary host details.

Command Mode

Exec > Global Configuration (config)

Syntax

profile diameter-host-selection host_selection_name  algorithm hosts hosts_precedence  [ primary host host_ip_address  primary realm realm_name |  secondary host host_ip_address secondary realm realm_name ]  

profile diameter-host-selectionhost_selection_name

Specify the Diameter host selection profile name.

algorithm

Choose the algorithm to select the host.

Must be one of the following:

  • ipaddr-modulus

  • msisdn-modulus

  • round-robin

hosts hosts_precedence

Specify the precedence of the host in the form of index from 1-64

Must be in the range of 1 to 64.

primary host host_ip_address

Specify the primary host name.

primary realm realm_name

Specify the primary host realm.

secondary host host_ip_address

Specify the secondary host name.

secondary realm realm_name

Specify the secondary host realm.

profile dnn

Configures DNN profile.

Command Mode

Exec > Global Configuration (config)

Syntax


profile dnn dnn_profile_name  intershat  dnn_intershat[ 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 } | pcf-interaction { false | true } | pcscf-profile profile_name | ppd-profile profile_name | presence-reporting { false | true } | qci-qos-profile qci_qos_profile | qos-profile profile_name  | eventmgmt-policy  eventmgmt_policy_name   | suppress-uli-reporting-on-s5 { disable | enable } | upf-selection-policy upf_selection_policy | userplane-inactivity-timer timeout_period | virtual-mac mac_address | wps-profile profile_name ] 
    supported-features   [ inter-plmn-ho nat-binding-update  ] 

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.

hsmf-uri hsmf_uri

Specify the override hsmfURI.

Must be a string.

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.

pcf-interaction { false | true }

Specify to enable or disable PCF interaction.

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.

| eventmgmt-policy eventmgmt_policy_name

allows configuring priority-based event handling associated to a DNN.

suppress-uli-reporting-on-s5 { disable | enable }

Specify whether to suppress ULI only MBR towards the S5 interface.

Must be one of the following:

  • disable

  • enable

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.

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

wps-profile profile_name

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

Must be a string.

supported-features [ inter-plmn-ho nat-binding-update ]

Configure NAT binding update procedure in SMF.

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 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, OCS, PCF, PCRF, RADIUS 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 chapter.

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 chapter.

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 chapter.

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 chapter.

Usage Guidelines

Use this command to configure the secondary DNS server details.

profile dnn ims mark

Configures marking 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 from the following: 1-9, 65, 66, 69, 70, 80, 82, 83, 128-254.

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

Usage Guidelines

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

profile dnn max-upf-sessions

Configures maximum UPF sessions at DNN level.

Command Mode

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

Syntax

profile dnn dnn_profile_namemax-upf-sessions max_upf_sessions_count 

profile dnn dnn_profile_name

Configures DNN profile.

max-upf-sessions max_upf_sessions_count

Configures maximum supported session per vDnn per UPF on SMF.

Usage Guidelines

Use this command to configure maximum UPF sessions on a DNN level.

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  | pcrf | ocs   | sepp | 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.

pcrf profile_name

Specify name of the PCRF network element profile to enable Gx interface.

Must be a string.

ocs profile_name

Specify name of the OCS network element profile to enable Gy interface.

Must be a string.

sepp profile_name

Specify name of the SEPP network element profile.

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 chapter.

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 chapter.

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).

Must be a string in the hex-string6 pattern. For information on the hex-string6 pattern, see the Input Pattern Types chapter.

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 ] } 

mcc mobile_country_code

Specify the 3-digit Mobile Country Code.

mnc mobile_network_code

Specify the 2- or 3-digit Mobile Country Network.

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 skip-n10-registration

Ignores the UE registration messages towards UDM during the PDU setup and Wi-Fi attach procedures.

Command Mode

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

Syntax

profile dnn dnn_profile_name { skip-n10-registration rat-type [ NR | WIFI | ALL ] } 

skip-n10-registration rat-type [ NR | WIFI | ALL ]

Specify one of the following RAT types to ignore the UDM registration.

  • NR

  • WIFI

  • ALL


Note


When you configure this CLI command, the SMF ignores the UDM registration during session creation in the 5G and Wi-Fi network. The handover between 5G and Wi-Fi fails because ePDG doesn't find the target SMF that was handling the session. If the UE registration fails during 5G or Wi-Fi attach and if the UDM failure handling template (FHT) is configured as continue or ignore, then SMF reattempts the registration during Wi-Fi-to 5G and 5G to Wi-Fi handovers.


Usage Guidelines

Use this command to ignore the UDM registration messages during the PDU setup and Wi-Fi attach procedures.

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 timeout bearer-inactivity

Checks for low activity for a bearer.

Command Mode

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

Syntax

bearer-inactivity [ exclude-default-bearer { false | true } ] 

exclude-default-bearer { false | true }

Specify whether to exclude default bearer from the Bearer Inactivity feature.

Must be one of the following:

  • false

  • true

Usage Guidelines

Use this command to configure checking for low activity for a bearer.

profile dnn timeout bearer-inactivity gbr

Checks for low activity for a GBR bearer.

Command Mode

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

Syntax

gbr duration bearer_inactivity_timer 

duration bearer_inactivity_timer

Specify the bearer inactivity timeout period in seconds.

Must be an integer in the range of 300-2592000.

Usage Guidelines

Use this command to configure checking for low activity for a GBR bearer.

profile dnn timeout bearer-inactivity gbr volume

Configures data traffic threshold values for a bearer.

Command Mode

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

Syntax

volume { [ downlink downlink_data_traffic ] [ total total_data_traffic ] [ uplink uplink_data_traffic ] } 

downlink downlink_data_traffic

Specify the downlink data traffic for a bearer in bytes.

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

total total_data_traffic

Specify the total uplink and downlink data traffic for a bearer in bytes.

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

uplink uplink_data_traffic

Specify the uplink data traffic for a bearer in bytes.

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

Usage Guidelines

Use this command to configure the data traffic threshold values for a bearer.

profile dnn timeout bearer-inactivity non-gbr

Checks for low activity for a non-GBR bearer.

Command Mode

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

Syntax

gbr duration bearer_inactivity_timer 

duration bearer_inactivity_timer

Specify the bearer inactivity timeout period in seconds.

Must be an integer in the range of 300-2592000.

Usage Guidelines

Use this command to configure checking for low activity for a non-GBR bearer.

profile dnn timeout bearer-inactivity non-gbr volume

Configures data traffic threshold values for a bearer.

Command Mode

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

Syntax

volume { [ downlink downlink_data_traffic ] [ total total_data_traffic ] [ uplink uplink_data_traffic ] } 

downlink downlink_data_traffic

Specify the downlink data traffic for a bearer in bytes.

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

total total_data_traffic

Specify the total uplink and downlink data traffic for a bearer in bytes.

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

uplink uplink_data_traffic

Specify the uplink data traffic for a bearer in bytes.

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

Usage Guidelines

Use this command to configure the data traffic threshold values for a bearer.

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 in the range of 200-10000.

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 chapter.

-Or-

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

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 ecgi-group

Configures ECGI group profile parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile ecgi-group group_name 

ecgi-group group_name

Specify name of the ECGI group.

Must be a string.

Usage Guidelines

Use this command to configure ECGI group profile parameters.

profile ecgi-group ecgis

Configures the list of MCC, MNC, TAC, and ECGI groups.

Command Mode

Exec > Global Configuration (config) > ECGI Group Configuration (config-ecgi-group-profile_name )

Syntax

mcc mobile_country_code mnc mobile_network_code 

mcc mobile_country_code

Specify the Mobile Country Code (MCC).

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

mnc mobile_network_code

Specify the Mobile Network Code (MNC).

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

Usage Guidelines

Use this command to configure the list of MCC, MNC, TAC, and ECGI groups.

You can configure a maximum of 16 elements with this command.

profile ecgi-group ecgis ecgi

Configures ECGI group parameters.

Command Mode

Exec > Global Configuration (config) > ECGI Group Configuration (config-ecgi-group-profile_name ) > ECGI Group MCC/MNC Configuration (config-ecgi-group-mcc_mnc )

Syntax

ecgi list ecgi_values 

list ecgi_values

Specify the list of ECGI values - 7 digit hex string Eutra Cell ID. For example, A12345f.

Must be a string in the hex-stringecgi pattern. For information on the hex-stringecgi pattern, see the Input Pattern Types chapter.

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

Usage Guidelines

Use this command to configure ECGI group parameters.

profile ecgi-group ecgis ecgi range

Configures ECGI range.

Command Mode

Exec > Global Configuration (config) > ECGI Group Configuration (config-ecgi-group-profile_name ) > ECGI Group MCC/MNC Configuration (config-ecgi-group-mcc_mnc )

Syntax

ecgi range start ecgi_range_start end ecgi_range_end 

end ecgi_range_end

Specify the ECGI range end value.

Must be a string in the hex-stringecgi pattern. For information on the hex-stringecgi pattern, see the Input Pattern Types chapter.

start ecgi_range_start

Specify the ECGI range start value.

Must be a string in the hex-stringecgi pattern. For information on the hex-stringecgi pattern, see the Input Pattern Types chapter.

Usage Guidelines

Use this command to configure an ECGI range.

You can configure a maximum of 64 elements with this command.

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 diameter

Configures a failure handling profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile failure-handling failure_handling_profile_name interface diameter message message_type failure-type [ any | local-error | result-code { result-code-value | result-code-range-start-value | result-code-range-end-value | comma-separated-result-code-value-or-range ]retry count action [ continue action_options | terminate terminate_options ] 

profile failure-handling failure_handling_profile_name

Specify a name for the failure handling profile

Default Value: false.

interface diameter

Specify the failure handling profile for the Diameter interface.

message message_type

Specify name of the charging profile.

Must be one of the following:

  • any

  • credit-control-initial

  • credit-control-terminate

  • credit-control-update

failure-type [ any | local-error | result-code { result-code-value | result-code-range-start-value | result-code-range-end-value | comma-separated-result-code-value-or-range ]

Specify a Diameter failure type for which an action needs to be taken. Choose a failure type value from the available options. This

Must be one of the following:

  • any

  • local-error

  • result-code

retry count

Specify the number of alternate peers to retry on receiving a failure response.

Default Value: zero.

action continue continue_option

Choose an action value as continue. Choose sub-actions of the selected action from the available options, as required

Must be one of the following:

  • discard-traffic

  • local-fallback

  • retry-server-on-event

  • send-ccrt-on-call-termination

action terminate terminate_option

Choose an action value as terminate. Choose sub-actions of the selected action from the available options, as required

Must be one of the following:

  • with-term-request

  • without-term-request

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 condition condition 

action action_type

Specify the action type for the cause.

Must be one of the following:

  • terminate

condition condition

Specify the condition.

Must be one of the following:

  • handover-cancel

  • handover-execution

  • handover-preparation

  • idft

  • modify

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 gtpp-profile gtpp

Configures a GTPP profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile gtpp-profile  profile_name gtpp [ dictionary| ignore  ignore_value instance-id [ charging-agent address IPv4_adress port UDP_portserver{ cgf address IPv4_adress max-cdrs max_cdrs { node-alive Enable | Disable } }port UDP_port priority priority deadtime time_interval echo-interval  echo_interval timeout timeout_val max-retry max_retry max-pdu-size max_pdu_size wait-time time_interval }| local-storage | mode[ localstreaming-parallel ]| cgf-server-redundancy-support ] 

profile gtpp-profile profile_name gtpp

Specify a profile name for GTPP.

dictionary

Specify a dictionary for ASN.1 based encoding of a CDR.

ignore ignore_value

Specify the configuration to ignore the echo-rc-change. This CLI control option provides a flexibility to detect a CGF path failure due to a change in the echo response RC.

instance-id [ charging-agent address IPv4_adress port UDP_portserver{ cgf address IPv4_adress max-cdrs max_cdrs { node-alive Enable | Disable } }port UDP_port priority priority deadtime time_interval echo-interval echo_interval timeout timeout_val max-retry max_retry max-pdu-size max_pdu_size wait-time time_interval } ]

Specify the instance ID of a GR instance.

  • charging-agent : Configures the charging agent.

    • addressIPv4_address : Specify the IP address of the interface configured within the endpoint that is used to transmit CDR records to the CGF.

    • port : Specify the UDP port.


      Note


      The Charging agent IP address and port configured in GTPP profiles should also be configured in the endpoint gtpprime under the Gz interface. The Runtime configuration update of the Charging agent IP address and port is not recommended. Ensure to add new profile with new Charging agent IP address and port.
  • server : Configure server details.

    • cgf : Configure the CGF server with the following parameters.

      • address IPv4_address: Enter the IPv4 address of CGF server, using dotted-decimal notation range.

      • max : Configures maximum number of unacknowledged CDRs for a CGF. Must be an integer ranging from 1 to 2000.


        Note


        The runtime configuration change of max is not recommended. Follow the Method of procedure:


        1. Delete the cgf having old max and then commit the change.

        2. Add the cgf again with a new max value.

      • node-alive Enable | Disable : Enables or disables sending Node Alive Request to a GTPP Server (such as CGF).

      • port : Specify which port that the CGF is using.

      • priority : Specify the relative priority of this server when system is selecting which CGF server to use.

    • deadtime : Configure the deadtime in seconds. Must be an integer ranging from 1 to 65535. Default value is 120.

    • max-cdrs : Designate the maximum number of CDRs in a GTPP message. Must be an integer ranging from 1 to 255.

    • max-pdu-size : Designate the maximum size of the PDU, in bytes. Must be an ranging from 1024 to 1460.

    • timeout : Specify the number of times the system attempts to communicate with a CGF that is not responding.

    • wait-time : Specify the time to wait before sending the GTPP request.

local-storage

Specify local storage details.

mode [ localstreaming-parallel ]

Specify a storage mode to be used.

  • local : Specify the use of HDD to store CDRs

  • streaming-parallel : Specify the use of HDD to store CDRs, if CGF fails. When CGF comes up, stream the CDRs to the CGF. Streaming is in a parallel and newly generated CDRs are sent to CGF along with CDRs streamed from HDD.

cgf-server-redundancy-support

Enable or disable the CGF server redundancy support per GTPP profile. By default this configuration is disabled.

profile icmpv6

Configures ICMPv6 profile parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile icmpv6 profile_name 

icmpv6 profile_name

Specify name of the ICMPv6 profile.

Must be a string.

Usage Guidelines

Use this command to configure the ICMPv6 profile parameters.

profile icmpv6 options

Configures ICMPv6 configuration parameters.

Command Mode

Exec > Global Configuration (config) > ICMPv6 Profile Configuration (config-icmpv6-profile_name )

Syntax

options { [ hop-limit hop_limit ] [ mtu mtu_size ] [ reachable-time reachable_period ] [ retrans-timer retransmission_period ] [ router-lifetime lifetime_period ] [ virtual-mac mac_address ] } 

hop-limit hop_limit

Specify the hop limit.

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

Default Value: 255.

mtu mtu_size

Specify the Maximum Transmission Unit (MTU) size.

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

Default Value: 1500.

reachable-time reachable_period

Specify the reachable time in milliseconds.

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

Default Value: 0.

retrans-timer retransmission_period

Specify the retransmission time in milliseconds.

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

Default Value: 0.

router-lifetime lifetime_period

Specify the router lifetime in seconds.

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

Default Value: 65535.

virtual-mac mac_address

Specify the local virtual MAC address.

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

Usage Guidelines

Use this command to configure the ICMPv6 configuration parameters.

profile icmpv6 ra trigger

Configures trigger to send router advertisements.

Command Mode

Exec > Global Configuration (config) > ICMPv6 Profile Configuration (config-icmpv6-profile_name )

Syntax

ra trigger handover { false | true } 

handover { false | true }

Specify whether to disable or enable handovers of Wi-Fi.

Must be one of the following:

  • false

  • true

Default Value: false.

Usage Guidelines

Use this command to configure trigger to send router advertisements.

profile interface-mapping default interface

This confiuration maps the Gm and Mw interfaces for P-CSCF restoration process.

Command Mode

Exec > Global Configuration (config)

Syntax

profile interface-mapping default interface [GM] [ ipv4  ipv4_address | ipv6 ipv6_address ] interface [MW] [ ipv4  ipv4_address | ipv6 ipv6_address ] 

profile interface-mapping default

Enables mapping Gm and Mw interfaces.

interface

Specifies the interfaces to be mapped. It has two possible values GM and MW .

[ ipv4 ipv4_address ]

Specifies the IPv4 address of the Gm or Mw interface to be mapped.

ipv6 ipv6_address

Specifies the IPv6 address of the Gm or Mw interface to be mapped.

Usage Guidelines

Use this command to map Gm and Mw interfaces to send the active P-CSCF addesses after a P-CSCF failure event.

profile load

Configures the load profile for load calculation and publishing.

Command Mode

Exec > Global Configuration (config)

Syntax

profile load load_profile_name [ load-calc-frequency load_calc_frequency ] [ load-fetch-frequency load_fetch_frequency ] 

load-calc-frequency load_calc_frequency

Specify the system load calculation interval in seconds.

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

Default Value: 10.

load-fetch-frequency load_fetch_frequency

Specify the time interval at which Service pod fetches load from Cache pod in seconds.

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

Default Value: 10.

load load_profile_name

Specify name of the load profile.

Must be a string.

Usage Guidelines

Use this command to configure the load profile for load calculation and publishing.

You can configure a maximum of one element with this command.

profile load advertise

Configures the advertising action.

Command Mode

Exec > Global Configuration (config) > Load Profile Configuration (config-load-profile_name )

Syntax

advertise [ change-factor change_factor ] [ interval interval ] 

change-factor change_factor

Specify the minimum change between current LCI and last indicated LCI, after which only advertising should happen.

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

Default Value: 5.

interval interval

Specify the periodicity of sending LCI to the peers in seconds.

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

Default Value: 300.

Usage Guidelines

Use this command to configure the advertising action.

profile load interface

Configures the list of interfaces.

Command Mode

Exec > Global Configuration (config) > Load Profile Configuration (config-load-profile_name )

Syntax

interface interface_type [ action action_on_interface ] 

action action_on_interface

Specify the action on the interface.

Must be one of the following:

  • advertise

interface interface_type

Specify the interface type.

Must be one of the following:

  • gtpc

Usage Guidelines

Use this command to configure the list of interfaces.

profile location-area-group

Configures the Location Area Group profile parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile location-area-group profile_name [ ecgi-group ecgi_group_name ] [ ncgi-group ncgi_group_name ] [ tai-group tai_group_name ] 

ecgi-group ecgi_group_name

Specify name of the ECGI group.

Must be a string.

location-area-group profile_name

Specify name of the Location Area Group profile.

Must be a string.

ncgi-group ncgi_group_name

Specify name of the NCGI group.

Must be a string.

tai-group tai_group_name

Specify name of the TAI group.

Must be a string.

Usage Guidelines

Use this command to configure the Location Area Group profile parameters.

profile message-handling nf type

Configures message handling profiles for different NFs.

Command Mode

Exec > Global Configuration (config)

Syntax

profile message-handling nf type { nrf | pcf | udm }   

nf type { nrf | pcf | udm }

Configure the message handling profile as either nrf, pcf, or udm.

Usage Guidelines

Use this command to configure message handling profiles for different NFs.

profile message-handling nf type udm mh-profile

Configures the UDM message handling profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile message-handling nf type udmmh-profile profile_name 

profile message-handling nf type udm mh-profile profile_name

Configure the UDM message handling profile.

Usage Guidelines

Use this command to configure UDM message handling profile at local configuration.

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 ncgi-group

Configures NCGI Group profile parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile ncgi-group profile_name 

ncgi-group profile_name

Specify name of the NCGI Group profile.

Must be a string.

Usage Guidelines

Use this command to configure NCGI Group profile parameters.

profile ncgi-group ncgis

Configures the list of MCC, MNC, TAC, and NCGI groups.

Command Mode

Exec > Global Configuration (config) > NCGI Group Profile Configuration (config-ncgi-group-profile_name )

Syntax

mcc mobile_country_code mnc mobile_network_code 

mcc mobile_country_code

Specify the Mobile Country Code (MCC). For example, 01, 001.

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

mnc mobile_network_code

Specify the Mobile Network Code (MNC). For example, 23, 456.

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

Usage Guidelines

Use this command to configure the list of MCC, MNC, TAC, and NCGI groups.

You can configure a maximum of 16 elements with this command.

profile ncgi-group ncgis ncgi

Configures NCGI Group parameters.

Command Mode

Exec > Global Configuration (config) > NCGI Group Profile Configuration (config-ncgi-group-profile_name ) > NCGI Group Profile MCC MNC Configuration (config-ncgi-group-mcc /mnc )

Syntax

ncgi list ncgi_values 

list ncgi_values

Specify the list of NCGI values - 9 digit hex string NR Cell ID.

Must be a string in the hex-stringncgi pattern. For information on the hex-stringncgi pattern, see the Input Pattern Types chapter.

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

Usage Guidelines

Use this command to configure NCGI Group parameters.

profile ncgi-group ncgis ncgi range

Configures an NCGI range.

Command Mode

Exec > Global Configuration (config) > NCGI Group Profile Configuration (config-ncgi-group-profile_name ) > NCGI Group Profile MCC MNC Configuration (config-ncgi-group-mcc /mnc )

Syntax

ncgi range start ncgi_range_start end ncgi_range_end 

end ncgi_range_end

Specify the NCGI range end value.

Must be a string in the hex-stringncgi pattern. For information on the hex-stringncgi pattern, see the Input Pattern Types chapter.

start ncgi_range_start

Specify the NCGI range start value.

Must be a string in the hex-stringncgi pattern. For information on the hex-stringncgi pattern, see the Input Pattern Types chapter.

Usage Guidelines

Use this command to configure an NCGI range.

You can configure a maximum of 64 elements with this command.

profile network-element amf

Configures the AMF profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile network-element amf amf_profile_name [ [ failure-handling-profile profile_name ] [ nf-client-profile profile_name ] [ query-target-plmn query_target_plmn ] ] 

amf amf_profile_name

Specify name of the AMF profile.

Must be a string.

failure-handling-profile profile_name

Specify name of the Failure Handling profile.

Must be a string.

nf-client-profile profile_name

Specify name of the NF Client profile.

Must be a string.

query-target-plmn query_target_plmn

Specify the query parameter target-plmn to be used.

Must be one of the following:

  • primary

  • serving

  • ue

Usage Guidelines

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

profile network-element amf discovery

Configures the discovery method.

Command Mode

Exec > Global Configuration (config) > AMF Profile Configuration (config-amf-profile_name )

Command Mode

Exec > Global Configuration (config) > CHF Profile Configuration (config-chf-profile_name )

Command Mode

Exec > Global Configuration (config) > PCF Profile Configuration (config-pcf-profile_name )

Command Mode

Exec > Global Configuration (config) > UDM Profile Configuration (config-udm-profile_name )

Syntax

discovery local 

local

Specify to use local configuration for NF discovery. NF discovery through NRF will be skipped.

Usage Guidelines

Use this command to configure the discovery method.

profile network-element amf query-params

Configures query parameter for NF discovery.

Command Mode

Exec > Global Configuration (config) > AMF Profile Configuration (config-amf-profile_name )

Command Mode

Exec > Global Configuration (config) > CHF Profile Configuration (config-chf-profile_name )

Command Mode

Exec > Global Configuration (config) > PCF Profile Configuration (config-pcf-profile_name )

Command Mode

Exec > Global Configuration (config) > UDM Profile Configuration (config-udm-profile_name )

Syntax

query-params query_parameters 

query-params query_parameters

Specify the query parameters.

Must be one of the following:

  • chf-supported-plmn

  • dnn

  • region-set

  • requester-snssais

  • tai

  • target-nf-instance-id

  • target-plmn

Usage Guidelines

Use this command to configure the query parameter for NF discovery.

profile network-element chf

Configures the CHF profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile network-element chf chf_profile_name [ [ failure-handling-profile profile_name ] [ failure-handling-profile-offline profile_name ] [ nf-client-profile profile_name ] [ nf-client-profile-offline profile_name ] [ nf-client-profile profile_name ] ] 

chf chf_profile_name

Specify name of the CHF profile.

Must be a string.

failure-handling-profile-offline profile_name

Specify the Failure Handling profile name for offline server.

Must be a string.

failure-handling-profile profile_name

Specify name of the Failure Handling profile.

Must be a string.

nf-client-profile-offline profile_name

Specify the NF Client profile name for offline server.

Must be a string.

nf-client-profile profile_name

Specify name of the NF Client profile.

Must be a string.

query-chf-supported-plmn plmn_type

Specify the PLMN type to be used for query parameter chf-supported-plmn.

Must be one of the following:

  • primary

  • serving

  • ue

query-target-plmn query_target_plmn

Specify the query parameter target-plmn to be used.

Must be one of the following:

  • primary

  • serving

  • ue

Usage Guidelines

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

profile network-element chf discovery

Configures the discovery method.

Command Mode

Exec > Global Configuration (config) > AMF Profile Configuration (config-amf-profile_name )

Command Mode

Exec > Global Configuration (config) > CHF Profile Configuration (config-chf-profile_name )

Command Mode

Exec > Global Configuration (config) > PCF Profile Configuration (config-pcf-profile_name )

Command Mode

Exec > Global Configuration (config) > UDM Profile Configuration (config-udm-profile_name )

Syntax

discovery local 

local

Specify to use local configuration for NF discovery. NF discovery through NRF will be skipped.

Usage Guidelines

Use this command to configure the discovery method.

profile network-element chf query-params

Configures query parameter for NF discovery.

Command Mode

Exec > Global Configuration (config) > AMF Profile Configuration (config-amf-profile_name )

Command Mode

Exec > Global Configuration (config) > CHF Profile Configuration (config-chf-profile_name )

Command Mode

Exec > Global Configuration (config) > PCF Profile Configuration (config-pcf-profile_name )

Command Mode

Exec > Global Configuration (config) > UDM Profile Configuration (config-udm-profile_name )

Syntax

query-params query_parameters 

query-params query_parameters

Specify the query parameters.

Must be one of the following:

  • chf-supported-plmn

  • dnn

  • requester-snssais

  • tai

  • target-nf-instance-id

  • target-plmn

Usage Guidelines

Use this command to configure the query parameter for NF discovery.

profile network-element nrf

Configures NRF profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile network-element nrf  nrf_profile_name nf-type nrf message-handling-profileprofile_name nf-type nrf mh-profile mh_profile_nameservice name type { nnrf-at | nnrf-bs | nnrf-nfd | nnrf-nfm } message type { nf-deregister | nf-list-retrieval | nf-profile-retrieval | nf-register | nf-status-notify | nf-status-subscribe | nf-status-unsubscribe | nf-updatenf-register }skip optional-ies locality
  ie smfinfolist tac-based  

message-handling-profile profile_name

Specify name of the Message Handling profile.

nf-type nrf

Specify the NF type as NRF.

mh-profile mh_profile_name

Specify the NRF message handling profile configuration.

service name type { nnrf-at | nnrf-bs | nnrf-nfd | nnrf-nfm }

Specify the NRF service name type as nnrf-at, nnrf-bs, nnrf-nfd, and nnrf-nfm.

message type { nf-deregister | nf-list-retrieval | nf-profile-retrieval | nf-register | nf-status-notify | nf-status-subscribe | nf-status-unsubscribe | nf-updatenf-register }

Specify the message type as as NF Deregister, NF list retrieval, NF profile retrieval, NF register, NF status notify, NF status subscribe, NF status unsubscribe, NF update, and NF regsiter.

skip optional-ies locality

Specify the locality parameter to skip for the selected NRF message.


Important


The skip optional-ies locality CLI configuration is currently ineffective and will require backend changes in the future releases. This CLI must be enabled to facilitate seamless rolling upgrade to future releases when this CLI backend support is fully available.


ie smfinfolist

Specify the smfInfoList Information Element name to be grouped.

tac-based

Groups the smfInfo attributes based on TAC Group.


Note


You are recommended to use this configuration only when you want to add new slice or TAC Group information.


Usage Guidelines

Use this command to configure the NRF profile.

profile network-element pcf

Configures the PCF profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile network-element pcf pcf_profile_name [ [ cause-map-class-profile profile_name ] [ failure-handling-profile profile_name ] [ nf-client-profile profile_name ] [ predefined-rule-prefix prefix_name ] [ query-target-plmn query_target_plmn ] [ response-timeout response_timeout_duration ] [ rulebase-prefix rulebase_prefix ] [ update-notify update_notify ] [ use-amf-provided-pcf [ false | true ] ] 

cause-map-class-profile profile_name

Specify name of the Cause Map Class profile.

Must be a string.

failure-handling-profile profile_name

Specify name of the Failure Handling profile.

Must be a string.

nf-client-profile profile_name

Specify name of the NF Client profile.

Must be a string.

pcf pcf_profile_name

Specify name of the PCF profile.

Must be a string.

predefined-rule-prefix prefix_name

Specify the predefined rule prefix string.

Must be a string.

query-target-plmn query_target_plmn

Specify the query parameter target-plmn to be used.

Must be one of the following:

  • primary

  • serving

  • ue

response-timeout response_timeout_duration

Specify the response timeout duration, in milliseconds.

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

Default Value: 4000.

rulebase-prefix rulebase_prefix

Specify the rulebase prefix string.

Must be a string.

update-notify update_notify

Specify the SMF Immediate UpdateNotify Response behavior.

Must be one of the following:

  • expidite-response

use-amf-provided-pcf { false | true }

Specify to enable or disable PCF discovery using PCF ID provided by the AMF.

Must be one of the following:

  • false

  • true

Default Value: true.

Usage Guidelines

Use this command to configure the PCF profile. The CLI prompt changes to the PCF Profile Configuration mode ().

profile network-element pcf bitrates

Configures bitrates round-up parameter.

Command Mode

Exec > Global Configuration (config) > PCF Profile Configuration (config-pcf-profile_name )

Syntax

bitrates rounded-up 

rounded-up

Specify to round up.

Usage Guidelines

Use this command to configure bitrates round-up parameter.

profile network-element pcf discovery

Configures the discovery method.

Command Mode

Exec > Global Configuration (config) > AMF Profile Configuration (config-amf-profile_name )

Command Mode

Exec > Global Configuration (config) > CHF Profile Configuration (config-chf-profile_name )

Command Mode

Exec > Global Configuration (config) > PCF Profile Configuration (config-pcf-profile_name )

Command Mode

Exec > Global Configuration (config) > UDM Profile Configuration (config-udm-profile_name )

Syntax

discovery local 

local

Specify to use local configuration for NF discovery. NF discovery through NRF will be skipped.

Usage Guidelines

Use this command to configure the discovery method.

profile network-element pcf query-params

Configures query parameter for NF discovery.

Command Mode

Exec > Global Configuration (config) > AMF Profile Configuration (config-amf-profile_name )

Command Mode

Exec > Global Configuration (config) > CHF Profile Configuration (config-chf-profile_name )

Command Mode

Exec > Global Configuration (config) > PCF Profile Configuration (config-pcf-profile_name )

Command Mode

Exec > Global Configuration (config) > UDM Profile Configuration (config-udm-profile_name )

Syntax

query-params query_parameters 

query-params query_parameters

Specify the query parameters.

Must be one of the following:

  • chf-supported-plmn

  • dnn

  • requester-snssais

  • tai

  • target-nf-instance-id

  • target-plmn

Usage Guidelines

Use this command to configure the query parameter for NF discovery.

profile network-element scp

Configures the SCP profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile network-element scp scp_profile_name [ nf-client-profile scp_client_profile_name failure-handling-profilefailure_handling_scp_profile_name] [ query-target-plmn query_target_plmn ] 

profile network-element scpscp_profile_name

Specify the SCP as the network element profile.

scp_profile_name must an alphanumeric string representing the corresponding network element profile name.

nf-client-profile scp_client_profile_name

Specify the SCP client profile.

scp_client_profile_name must an alphanumeric string representing the corresponding NF client profile name.

failure-handling-profilefailure_handling_scp_profile_name

Specify the SCP failure handling network profile for the configured SCP.

failure_handling_scp_profile_name must an alphanumeric string representing the corresponding SCP failure handling network profile name.

Usage Guidelines

Use this command to configure the SCP profile.

profile network-element sepp

Configures the SEPP profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile network-element sepp sepp_profile_name [ [ failure-handling-profile profile_name ] [ nf-client-profile profile_name ] [ query-target-plmn query_target_plmn ] ] 

failure-handling-profile profile_name

Specify name of the Failure Handling profile.

Must be a string.

nf-client-profile profile_name

Specify name of the NF Client profile.

Must be a string.

query-target-plmn query_target_plmn

Specify the query parameter target-plmn to be used.

Must be one of the following:

  • primary

  • serving

  • ue

sepp sepp_profile_name

Specify name of the SEPP profile.

Must be a string.

Usage Guidelines

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

profile network-element sepp discovery

Configures the discovery method.

Command Mode

Exec > Global Configuration (config) > AMF Profile Configuration (config-amf-profile_name )

Command Mode

Exec > Global Configuration (config) > CHF Profile Configuration (config-chf-profile_name )

Command Mode

Exec > Global Configuration (config) > PCF Profile Configuration (config-pcf-profile_name )

Command Mode

Exec > Global Configuration (config) > UDM Profile Configuration (config-udm-profile_name )

Syntax

discovery local 

local

Specify to use local configuration for NF discovery. NF discovery through NRF will be skipped.

Usage Guidelines

Use this command to configure the discovery method.

profile network-element sepp query-params

Configures query parameter for NF discovery.

Command Mode

Exec > Global Configuration (config) > AMF Profile Configuration (config-amf-profile_name )

Command Mode

Exec > Global Configuration (config) > CHF Profile Configuration (config-chf-profile_name )

Command Mode

Exec > Global Configuration (config) > PCF Profile Configuration (config-pcf-profile_name )

Command Mode

Exec > Global Configuration (config) > UDM Profile Configuration (config-udm-profile_name )

Syntax

query-params query_parameters 

query-params query_parameters

Specify the query parameters.

Must be one of the following:

  • chf-supported-plmn

  • dnn

  • requester-snssais

  • tai

  • target-nf-instance-id

  • target-plmn

Usage Guidelines

Use this command to configure the query parameter for NF discovery.

profile network-element udm

Configures UDM profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile network-element udm udm_profile_name [ [ cause-map-class-profile profile_name ] [ failure-handling-profile profile_name ] [ message-handling-profile profile_name ] [ nf-client-profile profile_name ] ] 

cause-map-class-profile profile_name

Specify name of the Cause Map Class profile.

Must be a string.

failure-handling-profile profile_name

Specify name of the Failure Handling profile.

Must be a string.

message-handling-profile profile_name

Specify name of the Message Handling profile.

nf-client-profile profile_name

Specify name of the NF Client profile.

Must be a string.

query-target-plmn query_target_plmn

Specify the query parameter target-plmn to be used.

Must be one of the following:

  • primary

  • serving

  • ue

response-timeout response_timeout_duration

Specify the response timeout duration in milliseconds.

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

Default Value: 4000.

udm udm_profile_name

Specify name of the UDM profile.

Must be a string.

Usage Guidelines

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

profile network-element udm discovery

Configures the discovery method.

Command Mode

Exec > Global Configuration (config) > AMF Profile Configuration (config-amf-profile_name )

Command Mode

Exec > Global Configuration (config) > CHF Profile Configuration (config-chf-profile_name )

Command Mode

Exec > Global Configuration (config) > PCF Profile Configuration (config-pcf-profile_name )

Command Mode

Exec > Global Configuration (config) > UDM Profile Configuration (config-udm-profile_name )

Syntax

discovery local 

local

Specify to use local configuration for NF discovery. NF discovery through NRF will be skipped.

Usage Guidelines

Use this command to configure the discovery method.

profile network-element udm failure-handling-profile-rat

Configures Failure Handling profile specific to RAT type.

Command Mode

Exec > Global Configuration > Profile Configuration

Syntax

failure-handling-profile-rat rat-type rat_type failure-handling-profile failure_handling_profile_name 

failure-handling-profile failure_handling_profile_name

Specify name of Failure Handling profile.

Must be a string.

rat-type rat_type

Specify the RAT type.

Must be one of the following:

  • eutra

  • nr

  • wlan

Usage Guidelines

Use this command to configure Failure Handling profile specific to RAT type.

profile network-element udm query-params

Configures query parameter for NF discovery.

Command Mode

Exec > Global Configuration (config) > AMF Profile Configuration (config-amf-profile_name )

Command Mode

Exec > Global Configuration (config) > CHF Profile Configuration (config-chf-profile_name )

Command Mode

Exec > Global Configuration (config) > PCF Profile Configuration (config-pcf-profile_name )

Command Mode

Exec > Global Configuration (config) > UDM Profile Configuration (config-udm-profile_name )

Syntax

query-params query_parameters 

query-params query_parameters

Specify the query parameters.

Must be one of the following:

  • chf-supported-plmn

  • dnn

  • requester-snssais

  • tai

  • target-nf-instance-id

  • target-plmn

Usage Guidelines

Use this command to configure the query parameter for NF discovery.

profile network-element upf

Configures the UPF profile.

Command Mode

Exec > Global Configuration (config)

Syntax

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

max-upf-sessions max_upf_sessions_count

Configures maximum UPF sessions on SMF.

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.

dual-stack-transport { false | true }

Specify to enable or disable the dual stack transport for the N3 interface.

When the dual-stack-transport true command is configured, SMF sends the Outer Header Removal (OHR) IE with the value 6 for the IPv6 address on the supported interfaces.

Must be one of the following:

  • false

  • true

Default Value: false.


Note


This CLI configuration is applicable for SMF with the legacy interfaces as well.


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 the name of the UPF Group profile.

Must be a string.

upf upf_profile_name

Specify the name of the UPF peer.

Must be a string.

Usage Guidelines

Use this command to configure the UPF profile. When the active profile is removed, clears if any existing sessions and UPF will be detached. 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 chapter.

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 chapter.

Usage Guidelines

Use this command to confgure the N4 peer address.

profile nf-client nf-type amf amf-profile

Configures AMF profile parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile nf-client nf-type amf amf-profile profile_name 

amf-profile profile_name

Specify the AMF profile name

Must be a string.

Usage Guidelines

Use this command to configure AMF profile parameters.

profile nf-client nf-type amf amf-profile locality

Configures the AMF profile locality parameter.

Command Mode

Exec > Global Configuration (config) > AMF Profile Configuration (config-amf-profile-profile_name )

Syntax

locality locality_name [ priority locality_priority ] 

locality locality_name

Specify name of the locality.

Must be a string.

priority locality_priority

Specify priority of the locality configuration.

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

Usage Guidelines

Use this command to configure the AMF profile locality parameter.

profile nf-client nf-type amf amf-profile locality service name type

Configures the AMF service name type parameter.

Command Mode

Exec > Global Configuration (config) > AMF Configuration (config-amf) > Failure Handling profile_name Configuration mode (config-failure-handling-profile_name )

Syntax

type amf_service_name_type 

responsetimeout response_timeout

Specify the response timeout interval in milliseconds.

Must be an integer.

Default Value: 2000.

type amf_service_name_type

Specify the service name type.

Must be one of the following:

  • namf-comm

  • namf-evts

  • namf-loc

  • namf-mt

Usage Guidelines

Use this command to configure the AMF service name type parameter.

profile nf-client nf-type amf amf-profile locality service name type endpoint-profile

Configures endpoint profile parameters.

Command Mode

Exec > Global Configuration

Syntax

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

api-root api_root

Specify the API root.

Must be a string.

api-uri-prefix api_uri_prefix

Specify the API URI prefix.

Must be a string.

capacity capacity_value

Specify the profile capacity.

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

Default Value: 10.

endpoint-profile endpoint_profile_name

Specify name of the endpoint profile.

Must be a string.

priority profile_priority

Specify the priority of the profile.

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

Default Value: 1.

uri-scheme uri_scheme

Specify the URI scheme.

Must be one of the following:

  • http : HTTP.

  • https : HTTPS.

Usage Guidelines

Use this command to configure endpoint profile parameters.

profile nf-client nf-type amf amf-profile locality service name type endpoint-profile endpoint-name

Configures the endpoint name parameter.

Command Mode

Exec > Global Configuration

Syntax

endpoint-name endpoint_name [ priority node_priority | capacity node_capacity ] 

capacity node_capacity

Specify the node capacity for the endpoint.

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

endpoint-name endpoint_name

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

Must be a string.

priority node_priority

Specify the node priority for the endpoint.

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

Usage Guidelines

Use this configuration to configure the endpoint name parameter.

profile nf-client nf-type amf amf-profile locality service name type endpoint-profile endpoint-name primary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type amf amf-profile locality service name type endpoint-profile endpoint-name secondary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type amf amf-profile locality service name type endpoint-profile endpoint-name tertiary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type amf amf-profile locality service name type endpoint-profile version uri-version

Configures the URI version.

Command Mode

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

Syntax

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

full-version full_version

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

Must be a string.

uri-version uri_version

Specify the URI version.

Must be a string in the pattern v\d.

Usage Guidelines

Use this command to configure the URI version information.

profile nf-client nf-type ausf ausf-profile

Configures AUSF profile parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile nf-client nf-type ausf ausf-profile profile_name 

ausf-profile profile_name

Specify name of the AUSF profile.

Must be a string.

Usage Guidelines

Use this command to configure AUSF profile parameters.

profile nf-client nf-type ausf ausf-profile locality

Configures the AUSF profile locality parameter.

Command Mode

Exec > Global Configuration (config) > AUSF Profile Configuration (config-ausf-profile-profile_name )

Syntax

locality locality_name [ priority locality_priority ] 

locality locality_name

Specify name of the locality.

Must be a string.

priority locality_priority

Specify priority of the locality configuration.

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

Usage Guidelines

Use this command to configure the AUSF profile locality parameter.

profile nf-client nf-type ausf ausf-profile locality service name type

Configures the AUSF service name type parameter.

Command Mode

Exec > Global Configuration (config) > AUSF Configuration (config-ausf) > Failure Handling profile_name Configuration mode (config-failure-handling-profile_name )

Syntax

type ausf_service_name_type 

responsetimeout response_timeout

Specify the response timeout interval in milliseconds.

Must be an integer.

Default Value: 2000.

type ausf_service_name_type

Specify the AUSF service name type.

Must be one of the following:

  • nausf-auth

Usage Guidelines

Use this command to configure the AUSF service name type parameter.

profile nf-client nf-type ausf ausf-profile locality service name type endpoint-profile

Configures endpoint profile parameters.

Command Mode

Exec > Global Configuration

Syntax

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

api-root api_root

Specify the API root.

Must be a string.

api-uri-prefix api_uri_prefix

Specify the API URI prefix.

Must be a string.

capacity capacity_value

Specify the profile capacity.

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

Default Value: 10.

endpoint-profile endpoint_profile_name

Specify name of the endpoint profile.

Must be a string.

priority profile_priority

Specify the priority of the profile.

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

Default Value: 1.

uri-scheme uri_scheme

Specify the URI scheme.

Must be one of the following:

  • http : HTTP.

  • https : HTTPS.

Usage Guidelines

Use this command to configure endpoint profile parameters.

profile nf-client nf-type ausf ausf-profile locality service name type endpoint-profile endpoint-name

Configures the endpoint name parameter.

Command Mode

Exec > Global Configuration

Syntax

endpoint-name endpoint_name [ priority node_priority | capacity node_capacity ] 

capacity node_capacity

Specify the node capacity for the endpoint.

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

endpoint-name endpoint_name

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

Must be a string.

priority node_priority

Specify the node priority for the endpoint.

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

Usage Guidelines

Use this configuration to configure the endpoint name parameter.

profile nf-client nf-type ausf ausf-profile locality service name type endpoint-profile endpoint-name primary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type ausf ausf-profile locality service name type endpoint-profile endpoint-name secondary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type ausf ausf-profile locality service name type endpoint-profile endpoint-name tertiary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type ausf ausf-profile locality service name type endpoint-profile version uri-version

Configures the URI version.

Command Mode

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

Syntax

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

full-version full_version

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

Must be a string.

uri-version uri_version

Specify the URI version.

Must be a string in the pattern v\d.

Usage Guidelines

Use this command to configure the URI version information.

profile nf-client nf-type chf chf-profile

Configures the CHF profile parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile nf-client nf-type chf chf-profile profile_name 

chf-profile profile_name

Specify name of the CHF profile.

Must be a string.

Usage Guidelines

Use this command to configure the CHF profile parameters.

profile nf-client nf-type chf chf-profile locality

Configures the CHF profile locality parameter.

Command Mode

Exec > Global Configuration (config) > CHF Profile Configuration (config-chf-profile-profile_name )

Syntax

locality locality_name [ priority locality_priority ] 

locality locality_name

Specify name of the locality.

Must be a string.

priority locality_priority

Specify priority of the locality configuration.

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

Usage Guidelines

Use this command to configure the CHF profile locality parameter.

profile nf-client nf-type chf chf-profile locality service name type

Configures the CHF service name type parameter.

Command Mode

Exec > Global Configuration (config) > CHF Configuration (config-chf) > Failure Handling profile_name Configuration mode (config-failure-handling-profile_name )

Syntax

type service_name_type 

responsetimeout response_timeout

Specify the response timeout interval in milliseconds.

Must be an integer.

Default Value: 2000.

type service_name_type

Specify the CHF service name type.

Must be one of the following:

  • nchf-convergedcharging

  • nchf-spendinglimitcontrol

Usage Guidelines

Use this command to configure the CHF service name type parameter.

profile nf-client nf-type chf chf-profile locality service name type endpoint-profile

Configures endpoint profile parameters.

Command Mode

Exec > Global Configuration

Syntax

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

api-root api_root

Specify the API root.

Must be a string.

api-uri-prefix api_uri_prefix

Specify the API URI prefix.

Must be a string.

capacity capacity_value

Specify the profile capacity.

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

Default Value: 10.

endpoint-profile endpoint_profile_name

Specify name of the endpoint profile.

Must be a string.

priority profile_priority

Specify the priority of the profile.

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

Default Value: 1.

uri-scheme uri_scheme

Specify the URI scheme.

Must be one of the following:

  • http : HTTP.

  • https : HTTPS.

Usage Guidelines

Use this command to configure endpoint profile parameters.

profile nf-client nf-type chf chf-profile locality service name type endpoint-profile endpoint-name

Configures the endpoint name parameter.

Command Mode

Exec > Global Configuration

Syntax

endpoint-name endpoint_name [ priority node_priority | capacity node_capacity ] 

capacity node_capacity

Specify the node capacity for the endpoint.

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

endpoint-name endpoint_name

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

Must be a string.

priority node_priority

Specify the node priority for the endpoint.

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

Usage Guidelines

Use this configuration to configure the endpoint name parameter.

profile nf-client nf-type chf chf-profile locality service name type endpoint-profile endpoint-name primary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type chf chf-profile locality service name type endpoint-profile endpoint-name secondary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type chf chf-profile locality service name type endpoint-profile endpoint-name tertiary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type chf chf-profile locality service name type endpoint-profile version uri-version

Configures the URI version.

Command Mode

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

Syntax

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

full-version full_version

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

Must be a string.

uri-version uri_version

Specify the URI version.

Must be a string in the pattern v\d.

Usage Guidelines

Use this command to configure the URI version information.

profile nf-client nf-type eir eir-profile

Configures EIR profile parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile nf-client nf-type eir eir-profile eir_profile_name 

eir-profile eir_profile_name

Specify name of the EIR profile.

Must be a string.

Usage Guidelines

Use this command to configure the EIR profile parameters.

profile nf-client nf-type eir eir-profile locality

Configures the EIR profile locality parameter.

Command Mode

Exec > Global Configuration (config) > EIR Profile Configuration (config-eir-profile-profile_name )

Syntax

locality locality_name [ priority priority ] 

locality locality_name

Specify name of the locality.

Must be a string.

priority priority

Specify the priority of the locality configuration.

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

Usage Guidelines

Use this command to configure the EIR profile locality parameter.

profile nf-client nf-type eir eir-profile locality service name type

Configures the EIR service name type parameter.

Command Mode

Exec > Global Configuration (config) > EIR Configuration (config-eir) > Failure Handling profile_name Configuration mode (config-failure-handling-profile_name )

Syntax

type service_name_type 

responsetimeout response_timeout_interval

Specify the response timeout interval in milliseconds.

Must be an integer.

Default Value: 2000.

type service_name_type

Specify the EIR service name type.

Must be one of the following:

  • n5g-eir-eic

Usage Guidelines

Use this command to configure the EIR service name type parameter.

profile nf-client nf-type eir eir-profile locality service name type endpoint-profile

Configures endpoint profile parameters.

Command Mode

Exec > Global Configuration

Syntax

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

api-root api_root

Specify the API root.

Must be a string.

api-uri-prefix api_uri_prefix

Specify the API URI prefix.

Must be a string.

capacity capacity_value

Specify the profile capacity.

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

Default Value: 10.

endpoint-profile endpoint_profile_name

Specify name of the endpoint profile.

Must be a string.

priority profile_priority

Specify the priority of the profile.

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

Default Value: 1.

uri-scheme uri_scheme

Specify the URI scheme.

Must be one of the following:

  • http : HTTP.

  • https : HTTPS.

Usage Guidelines

Use this command to configure endpoint profile parameters.

profile nf-client nf-type eir eir-profile locality service name type endpoint-profile endpoint-name

Configures the endpoint name parameter.

Command Mode

Exec > Global Configuration

Syntax

endpoint-name endpoint_name [ priority node_priority | capacity node_capacity ] 

capacity node_capacity

Specify the node capacity for the endpoint.

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

endpoint-name endpoint_name

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

Must be a string.

priority node_priority

Specify the node priority for the endpoint.

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

Usage Guidelines

Use this configuration to configure the endpoint name parameter.

profile nf-client nf-type eir eir-profile locality service name type endpoint-profile endpoint-name primary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type eir eir-profile locality service name type endpoint-profile endpoint-name secondary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type eir eir-profile locality service name type endpoint-profile endpoint-name tertiary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type eir eir-profile locality service name type endpoint-profile version uri-version

Configures the URI version.

Command Mode

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

Syntax

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

full-version full_version

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

Must be a string.

uri-version uri_version

Specify the URI version.

Must be a string in the pattern v\d.

Usage Guidelines

Use this command to configure the URI version information.

profile nf-client nf-type pcf pcf-profile

Configures PCF profile parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile nf-client nf-type pcf pcf-profile profile_name 

pcf-profile profile_name

Specify name of the PCF profile.

Must be a string.

Usage Guidelines

Use this command to configure the PCF profile.

profile nf-client nf-type pcf pcf-profile locality

Configures the PCF profile locality parameter.

Command Mode

Exec > Global Configuration (config) > PCF Profile Configuration (config-psf-profile-profile_name )

Syntax

locality locality_name [ priority locality_priority ] 

locality locality_name

Specify name of the locality.

Must be a string.

priority locality_priority

Specify priority of the locality configuration.

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

Usage Guidelines

Use this command to configure the PCF profile locality parameter.

profile nf-client nf-type pcf pcf-profile locality service name type

Configures the PCF service name type parameter.

Command Mode

Exec > Global Configuration (config) > PCF Configuration (config-pcf) > Failure Handling profile_name Configuration mode (config-failure-handling-profile_name )

Syntax

type service_name_type 

responsetimeout response_timeout

Specify the response timeout interval in milliseconds.

Must be an integer.

Default Value: 2000.

type service_name_type

Specify the PCF service name parameters.

Must be one of the following:

  • npcf-am-policy-control

  • npcf-bdtpolicycontrol

  • npcf-eventexposure

  • npcf-policyauthorization

  • npcf-smpolicycontrol

  • npcf-ue-policy-control

Usage Guidelines

Use this command to configure the PCF service name type parameter.

profile nf-client nf-type pcf pcf-profile locality service name type endpoint-profile

Configures endpoint profile parameters.

Command Mode

Exec > Global Configuration

Syntax

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

api-root api_root

Specify the API root.

Must be a string.

api-uri-prefix api_uri_prefix

Specify the API URI prefix.

Must be a string.

capacity capacity_value

Specify the profile capacity.

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

Default Value: 10.

endpoint-profile endpoint_profile_name

Specify name of the endpoint profile.

Must be a string.

priority profile_priority

Specify the priority of the profile.

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

Default Value: 1.

uri-scheme uri_scheme

Specify the URI scheme.

Must be one of the following:

  • http : HTTP.

  • https : HTTPS.

Usage Guidelines

Use this command to configure endpoint profile parameters.

profile nf-client nf-type pcf pcf-profile locality service name type endpoint-profile endpoint-name

Configures the endpoint name parameter.

Command Mode

Exec > Global Configuration

Syntax

endpoint-name endpoint_name [ priority node_priority | capacity node_capacity ] 

capacity node_capacity

Specify the node capacity for the endpoint.

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

endpoint-name endpoint_name

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

Must be a string.

priority node_priority

Specify the node priority for the endpoint.

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

Usage Guidelines

Use this configuration to configure the endpoint name parameter.

profile nf-client nf-type pcf pcf-profile locality service name type endpoint-profile endpoint-name primary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type pcf pcf-profile locality service name type endpoint-profile endpoint-name secondary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type pcf pcf-profile locality service name type endpoint-profile endpoint-name tertiary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type pcf pcf-profile locality service name type endpoint-profile version uri-version

Configures the URI version.

Command Mode

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

Syntax

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

full-version full_version

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

Must be a string.

uri-version uri_version

Specify the URI version.

Must be a string in the pattern v\d.

Usage Guidelines

Use this command to configure the URI version information.

profile nf-client nf-type scp scp-profile

Configures SCP profile parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile nf-client nf-type scp scp-profile profile_name scp-profile scp_profile_namescp-profile scp_profile_namelocality locality_name [ prioritypriority_value service name type service_name_type_value responsetimeout responsetimeout_value endpoint-profile endpoint-profile_name [ capacity capacity_value priority priority_value uri-scheme uri_scheme_value endpoint-name endpoint_name [ priority priority_value capacity endpoint-profile_name primary ip-address ipv4 ipv4_address primary ip-address port port_number] ] ]  

scp-profile scp_profile_name

Specify the name of the SCP profile.

Must be a string.

locality locality_name

Specify the locality of SCP.

prioritypriority_value

Specify the priority value.

service name type service_name_type_value

Specify the service name type.

responsetimeout responsetimeout_value

Specify the response timeout value.

endpoint-profile endpoint-profile_name

Specify the SCP endpoint profile name.

primary ip-address ipv4 ipv4_address

Specify the IPv4 address of the primary endpoint.

primary ip-address port primary_port_number

Specify the port number of primary endpoint.

Usage Guidelines

Use this command to configure the SCP profile parameters.

profile nf-client nf-type sepp sepp-profile

Configures SEPP profile parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile nf-client nf-type sepp sepp-profile profile_name 

sepp-profile profile_name

Specify name of the SEPP profile.

Must be a string.

Usage Guidelines

Use this command to configure SEPP profile parameters.

profile nf-client nf-type sepp sepp-profile locality

Configures the SEPP profile locality parameter.

Command Mode

Exec > Global Configuration (config) > SEPP Profile Configuration (config-sepp-profile-profile_name )

Syntax

locality locality_name [ priority locality_priority ] 

locality locality_name

Specify name of the locality.

Must be a string.

priority locality_priority

Specify priority of the locality configuration.

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

Usage Guidelines

Use this command to configure the SEPP profile locality parameter.

profile nf-client nf-type sepp sepp-profile locality service name type

Configures the SEPP service name type parameter.

Command Mode

Exec > Global Configuration (config) > SEPP Configuration (config-sepp) > Failure Handling profile_name Configuration mode (config-failure-handling-profile_name )

Syntax

type service_name_type [ responsetimeout response_timeout ] 

responsetimeout response_timeout

Specify the response timeout interval in milliseconds.

Must be an integer.

Default Value: 2000.

type service_name_type

Specify the service name type.

Must be one of the following:

  • nsmf-pdusession

Usage Guidelines

Use this command to configure the SEPP service name type parameter.

profile nf-client nf-type sepp sepp-profile locality service name type endpoint-profile

Configures endpoint profile parameters.

Command Mode

Exec > Global Configuration

Syntax

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

api-root api_root

Specify the API root.

Must be a string.

api-uri-prefix api_uri_prefix

Specify the API URI prefix.

Must be a string.

capacity capacity_value

Specify the profile capacity.

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

Default Value: 10.

endpoint-profile endpoint_profile_name

Specify name of the endpoint profile.

Must be a string.

priority profile_priority

Specify the priority of the profile.

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

Default Value: 1.

uri-scheme uri_scheme

Specify the URI scheme.

Must be one of the following:

  • http : HTTP.

  • https : HTTPS.

Usage Guidelines

Use this command to configure endpoint profile parameters.

profile nf-client nf-type sepp sepp-profile locality service name type endpoint-profile endpoint-name

Configures the endpoint name parameter.

Command Mode

Exec > Global Configuration

Syntax

endpoint-name endpoint_name [ priority node_priority | capacity node_capacity ] 

capacity node_capacity

Specify the node capacity for the endpoint.

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

endpoint-name endpoint_name

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

Must be a string.

priority node_priority

Specify the node priority for the endpoint.

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

Usage Guidelines

Use this configuration to configure the endpoint name parameter.

profile nf-client nf-type sepp sepp-profile locality service name type endpoint-profile endpoint-name primary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type sepp sepp-profile locality service name type endpoint-profile endpoint-name secondary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type sepp sepp-profile locality service name type endpoint-profile endpoint-name tertiary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type sepp sepp-profile locality service name type endpoint-profile version uri-version

Configures the URI version.

Command Mode

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

Syntax

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

full-version full_version

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

Must be a string.

uri-version uri_version

Specify the URI version.

Must be a string in the pattern v\d.

Usage Guidelines

Use this command to configure the URI version information.

profile nf-client nf-type smf smf-profile

Configures SMF profile parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile nf-client nf-type smf smf-profile smf_profile_name 

smf-profile smf_profile_name

Specify name of the SMF profile.

Must be a string.

Usage Guidelines

Use this command to configure the SMF profile parameters.

profile nf-client nf-type smf smf-profile locality

Configures the SMF profile locality parameter.

Command Mode

Exec > Global Configuration (config) > SMF Profile Configuration (config-smf-profile-profile_name )

Syntax

locality locality_name [ priority priority ] 

locality locality_name

Specify name of the locality.

Must be a string.

priority priority

Specify the priority of the locality configuration.

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

Usage Guidelines

Use this command to configure the SMF profile locality parameter.

profile nf-client nf-type smf smf-profile locality service name type

Configures the SMF service name type parameter.

Command Mode

Exec > Global Configuration (config) > SMF Configuration (config-smf) > Failure Handling profile_name Configuration mode (config-failure-handling-profile_name )

Syntax

type smf_service_name_type 

responsetimeout response_timeout

Specify the response timeout interval in milliseconds.

Must be an integer.

Default Value: 2000.

type smf_service_name_type

Specify the service name type.

Must be one of the following:

  • nsmf-pdusession

Usage Guidelines

Use this command to configure the SMF service name type parameter.

profile nf-client nf-type smf smf-profile locality service name type endpoint-profile

Configures endpoint profile parameters.

Command Mode

Exec > Global Configuration

Syntax

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

api-root api_root

Specify the API root.

Must be a string.

api-uri-prefix api_uri_prefix

Specify the API URI prefix.

Must be a string.

capacity capacity_value

Specify the profile capacity.

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

Default Value: 10.

endpoint-profile endpoint_profile_name

Specify name of the endpoint profile.

Must be a string.

priority profile_priority

Specify the priority of the profile.

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

Default Value: 1.

uri-scheme uri_scheme

Specify the URI scheme.

Must be one of the following:

  • http : HTTP.

  • https : HTTPS.

Usage Guidelines

Use this command to configure endpoint profile parameters.

profile nf-client nf-type smf smf-profile locality service name type endpoint-profile endpoint-name

Configures the endpoint name parameter.

Command Mode

Exec > Global Configuration

Syntax

endpoint-name endpoint_name [ priority node_priority | capacity node_capacity ] 

capacity node_capacity

Specify the node capacity for the endpoint.

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

endpoint-name endpoint_name

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

Must be a string.

priority node_priority

Specify the node priority for the endpoint.

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

Usage Guidelines

Use this configuration to configure the endpoint name parameter.

profile nf-client nf-type smf smf-profile locality service name type endpoint-profile endpoint-name primary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type smf smf-profile locality service name type endpoint-profile endpoint-name secondary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type smf smf-profile locality service name type endpoint-profile endpoint-name tertiary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type smf smf-profile locality service name type endpoint-profile version uri-version

Configures the URI version.

Command Mode

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

Syntax

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

full-version full_version

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

Must be a string.

uri-version uri_version

Specify the URI version.

Must be a string in the pattern v\d.

Usage Guidelines

Use this command to configure the URI version information.

profile nf-client nf-type udm udm-profile

Configures UDM profile parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile nf-client nf-type udm udm-profile udm_profile_name 

udm-profile udm_profile_name

Specify name of the UDM profile.

Must be a string.

Usage Guidelines

Use this command to configure the UDM profile for an NF client.

profile nf-client nf-type udm udm-profile locality

Configures the UDM profile locality parameters.

Command Mode

Exec > Global Configuration (config) > UDM Profile Configuration (config-udm-profile-profile_name )

Syntax

locality locality_name [ priority priority ] 

locality locality_name

Specify name of the locality.

Must be a string.

priority priority

This keyword sets the priority for the locality configuration.

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

Usage Guidelines

Use this command to configure the UDM profile locality parameter.

profile nf-client nf-type udm udm-profile locality service name type

Configures the UDM service name type parameter.

Command Mode

Exec > Global Configuration (config) > UDM Configuration (config-udm) > Failure Handling profile_name Configuration mode (config-failure-handling-profile_name )

Syntax

type service_name_type 

responsetimeout response_timeout

Specify the response timeout interval in milliseconds.

Must be an integer.

Default Value: 2000.

type service_name_type

Specify the UDM service name type.

Must be one of the following:

  • nudm-ee

  • nudm-pp

  • nudm-sdm

  • nudm-ueau

  • nudm-uecm

Usage Guidelines

Use this command to configure the UDM service name type parameter.

profile nf-client nf-type udm udm-profile locality service name type endpoint-profile

Configures endpoint profile parameters.

Command Mode

Exec > Global Configuration

Syntax

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

api-root api_root

Specify the API root.

Must be a string.

api-uri-prefix api_uri_prefix

Specify the API URI prefix.

Must be a string.

capacity capacity_value

Specify the profile capacity.

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

Default Value: 10.

endpoint-profile endpoint_profile_name

Specify name of the endpoint profile.

Must be a string.

priority profile_priority

Specify the priority of the profile.

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

Default Value: 1.

uri-scheme uri_scheme

Specify the URI scheme.

Must be one of the following:

  • http : HTTP.

  • https : HTTPS.

Usage Guidelines

Use this command to configure endpoint profile parameters.

profile nf-client nf-type udm udm-profile locality service name type endpoint-profile endpoint-name

Configures the endpoint name parameter.

Command Mode

Exec > Global Configuration

Syntax

endpoint-name endpoint_name [ priority node_priority | capacity node_capacity ] 

capacity node_capacity

Specify the node capacity for the endpoint.

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

endpoint-name endpoint_name

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

Must be a string.

priority node_priority

Specify the node priority for the endpoint.

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

Usage Guidelines

Use this configuration to configure the endpoint name parameter.

profile nf-client nf-type udm udm-profile locality service name type endpoint-profile endpoint-name primary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type udm udm-profile locality service name type endpoint-profile endpoint-name secondary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type udm udm-profile locality service name type endpoint-profile endpoint-name tertiary ip-address

Configures the endpoint IP address and port number.

Command Mode

Exec > Global Configuration

Syntax

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

ipv4 ipv4_address

Specify the IPv4 address.

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

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 chapter.

port port_number

Specify the port number.

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

Usage Guidelines

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

profile nf-client nf-type udm udm-profile locality service name type endpoint-profile version uri-version

Configures the URI version.

Command Mode

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

Syntax

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

full-version full_version

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

Must be a string.

uri-version uri_version

Specify the URI version.

Must be a string in the pattern v\d.

Usage Guidelines

Use this command to configure the URI version information.

profile nf-client-failure nf-type amf

Configures the AMF Profile Failure Handling parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile nf-client-failure nf-type amf 

Usage Guidelines

Use this command to configure the AMF Profile Failure Handling parameters. The CLI prompt changes to the AMF Configuration mode (config-amf).

profile nf-client-failure nf-type amf profile failure-handling

Configures the AMF failure handling template parameter.

Command Mode

Exec > Global Configuration (config) > AMF Configuration (config-amf)

Syntax

profile failure-handling fh_template_name 

failure-handling fh_template_name

Specify name of the AMF failure handling template.

Must be a string.

Usage Guidelines

Use this command to configure the AMF failure handling template parameter. The CLI prompt changes to the Failure Handling <profile_name> Configuration mode (config-failure-handling-<profile_name>).

profile nf-client-failure nf-type amf profile failure-handling service name type

Configures the AMF service name type parameter.

Command Mode

Exec > Global Configuration (config) > AMF Configuration (config-amf) > Failure Handling profile_name Configuration mode (config-failure-handling-profile_name )

Syntax

service name type amf_service_name_type 

responsetimeout response_timeout

Specify the response timeout interval in milliseconds.

Must be an integer.

Default Value: 2000.

type amf_service_name_type

Specify the AMF service name type.

Must be one of the following:

  • namf-comm

  • namf-evts

  • namf-loc

  • namf-mt

Usage Guidelines

Use this command to configure AMF service name type parameter. The CLI prompt changes to the Failure Handling Service Name Type Configuration mode (config-type-<service_name_type>)

profile nf-client-failure nf-type amf profile failure-handling service name type message type

Configures the AMF message type parameters.

Command Mode

Exec > Global Configuration (config) > AMF Configuration (config-amf) > Failure Handling profile_name Configuration mode (config-failure-handling-profile_name ) > Failure Handling Service Name Type Configuration (config-type-service_name_type )

Syntax

message type amf_message_type 

type amf_message_type

Specify the AMF message type.

Must be one of the following:

  • AmfCommCreateUeContext

  • AmfCommEBIAssignment

  • AmfCommN1N2MessageTransfer

  • AmfCommSMStatusChangeNotify

  • AmfCommUeContextTransfer

  • AmfCommUeContextTransferUpdate

Usage Guidelines

Use this command to configure the AMF message type parameters.

profile nf-client-failure nf-type amf profile failure-handling service name type message type status-code httpv2

Configures HTTPv2 status codes.

Command Mode

Exec > Global Configuration

Syntax

status-code httpv2 range { code code_value | retry retry_value | action action } 

action action

Specify the action.

Must be one of the following:

  • continue : Specify to continue the session without any retry. The retry count configuration is invalid with this action.

  • retry-and-continue : Specify to retry as per the configured retry count and continue the session.

  • retry-and-ignore

  • retry-and-terminate : Specify to retry as per the configured retry count and terminate the session in case all retry fails.

  • terminate : Specify to terminate the session without any retry. Retry count configuration is invalid with this action.

code code_value

Specify the code, or a range of status codes separated by either - (hyphen) or , (comma).

Must be an integer.

-Or-

Must be a string.

retransmit-interval retransmit_interval

Specify the retransmit interval in milliseconds.

Must be an integer.

retransmit retransmit

Specify the maximum number of retransmits.

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

retry retry_value

Specify the number of times the NF service must retry before proceeding with the action.

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

Usage Guidelines

Use this command to configure HTTPv2 status codes.

profile nf-client-failure nf-type ausf

Configures AUSF profile failure handling parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile nf-client-failure nf-type ausf 

Usage Guidelines

Use this command to configure AUSF failure handling parameters. The CLI prompt changes to the AUSF Configuration mode (config-ausf).

profile nf-client-failure nf-type ausf profile failure-handling

Configures the AUSF failure handling template parameters.

Command Mode

Exec > Global Configuration (config) > AUSF Configuration (config-ausf)

Syntax

profile failure-handling fh_template_name 

failure-handling fh_template_name

Specify name of the AUSF failure handling template.

Must be a string.

Usage Guidelines

Use this command to configure the AUSF failure handling template parameters. The CLI prompt changes to the Failure Handling Profile Configuration mode (config-failure-handling-<profile_name>).

profile nf-client-failure nf-type ausf profile failure-handling service name type

Configures the AUSF service name type.

Command Mode

Exec > Global Configuration (config) > AUSF Configuration (config-ausf) > Failure Handling profile_name Configuration mode (config-failure-handling-profile_name )

Syntax

service name type ausf_service_name_type 

responsetimeout response_timeout

Specify the response timeout interval in milliseconds.

Must be an integer.

Default Value: 2000.

type ausf_service_name_type

Specify the AUSF service name type.

Must be one of the following:

  • nausf-auth

Usage Guidelines

Use this command to configure the AUSF service name type.

profile nf-client-failure nf-type ausf profile failure-handling service name type message type

Configures the AUSF message type parameters.

Command Mode

Exec > Global Configuration (config) > AUSF Configuration (config-ausf) > Failure Handling profile_name Configuration mode (config-failure-handling-profile_name ) > Failure Handling Service Name Type Configuration (config-type-service_name_type )

Syntax

message type ausf_message_type 

type ausf_message_type

Specify the AUSF message type.

Must be one of the following:

  • AusfAuthenticationCfm

  • AusfAuthenticationReq

Usage Guidelines

Use this command to configure the AUSF message type parameters.

profile nf-client-failure nf-type ausf profile failure-handling service name type message type status-code httpv2

Configures HTTPv2 status codes.

Command Mode

Exec > Global Configuration

Syntax

status-code httpv2 range { code code_value | retry retry_value | action action } 

action action

Specify the action.

Must be one of the following:

  • continue : Specify to continue the session without any retry. The retry count configuration is invalid with this action.

  • retry-and-continue : Specify to retry as per the configured retry count and continue the session.

  • retry-and-ignore

  • retry-and-terminate : Specify to retry as per the configured retry count and terminate the session in case all retry fails.

  • terminate : Specify to terminate the session without any retry. Retry count configuration is invalid with this action.

code code_value

Specify the code, or a range of status codes separated by either - (hyphen) or , (comma).

Must be an integer.

-Or-

Must be a string.

retransmit-interval retransmit_interval

Specify the retransmit interval in milliseconds.

Must be an integer.

retransmit retransmit

Specify the maximum number of retransmits.

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

retry retry_value

Specify the number of times the NF service must retry before proceeding with the action.

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

Usage Guidelines

Use this command to configure HTTPv2 status codes.

profile nf-client-failure nf-type chf

Configures CHF profile failure handling parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile nf-client-failure nf-type chf 

Usage Guidelines

Use this command to configure CHF failure handling parameters. The CLI prompt changes to the CHF Configuration mode (config-chf).

profile nf-client-failure nf-type chf profile failure-handling

Configures the CHF failure handling template parameters.

Command Mode

Exec > Global Configuration (config) > CHF Configuration (config-chf)

Syntax

profile failure-handling fh_template_name 

failure-handling fh_template_name

Specify name of the CHF failure handling template.

Must be a string.

Usage Guidelines

Use this command to configure the CHF failure handling template for CHF profile.

profile nf-client-failure nf-type chf profile failure-handling service name type

Configures the CHF service name type parameters.

Command Mode

Exec > Global Configuration

Syntax

type chf_service_name_type 

responsetimeout response_timeout

Specify the response timeout interval in milliseconds.

Must be an integer.

Default Value: 2000.

type chf_service_name_type

Specify the CHF service name type.

Must be one of the following:

  • nchf-convergedcharging

  • nchf-spendinglimitcontrol

Usage Guidelines

Use this command to configure the CHF service name type parameters.

profile nf-client-failure nf-type chf profile failure-handling service name type message type

Configures the CHF message type parameters.

Command Mode

Exec > Global Configuration (config) > CHF Configuration (config-chf) > Failure Handling profile_name Configuration mode (config-failure-handling-profile_name ) > Failure Handling Service Name Type Configuration (config-type-service_name_type )

Syntax

message type chf_message_type 

type chf_message_type

Specify the CHF message type.

Must be one of the following:

  • ChfConvergedchargingCreate

  • ChfConvergedchargingDelete

  • ChfConvergedchargingUpdate

  • ChfSpendingLimitContolSubscribe

  • ChfSpendingLimitContolUnSubscribe

Usage Guidelines

Use this command to configure the CHF message type parameters.

profile nf-client-failure nf-type chf profile failure-handling service name type message type status-code httpv2

Configures HTTPv2 status codes.

Command Mode

Exec > Global Configuration

Syntax

status-code httpv2 range { code code_value | retry retry_value | action action } 

action action

Specify the action.

Must be one of the following:

  • continue : Specify to continue the session without any retry. The retry count configuration is invalid with this action.

  • retry-and-continue : Specify to retry as per the configured retry count and continue the session.

  • retry-and-ignore

  • retry-and-terminate : Specify to retry as per the configured retry count and terminate the session in case all retry fails.

  • terminate : Specify to terminate the session without any retry. Retry count configuration is invalid with this action.

code code_value

Specify the code, or a range of status codes separated by either - (hyphen) or , (comma).

Must be an integer.

-Or-

Must be a string.

retransmit-interval retransmit_interval

Specify the retransmit interval in milliseconds.

Must be an integer.

retransmit retransmit

Specify the maximum number of retransmits.

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

retry retry_value

Specify the number of times the NF service must retry before proceeding with the action.

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

Usage Guidelines

Use this command to configure HTTPv2 status codes.

profile nf-client-failure nf-type eir

Configures EIR profile failure handling parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile nf-client-failure nf-type eir 

Usage Guidelines

Use this command to configure EIR failure handling parameters. The CLI prompt changes to the EIR Configuration mode (config-eir).

profile nf-client-failure nf-type eir profile failure-handling

Configures the EIR failure handling template parameters.

Command Mode

Exec > Global Configuration (config) > EIR Configuration (config-eir)

Syntax

profile failure-handling fh_template_name 

failure-handling fh_template_name

Specify name of the EIR failure handling template.

Must be a string.

Usage Guidelines

Use this command to configure the EIR failure handling template for EIR profile.

profile nf-client-failure nf-type eir profile failure-handling service name type

Configures the EIR service name type parameters.

Command Mode

Exec > Global Configuration

Syntax

type eir_service_name_type 

responsetimeout response_timeout

Specify the response timeout interval in milliseconds.

Must be an integer.

Default Value: 2000.

type eir_service_name_type

Specify the EIR service name type.

Must be one of the following:

  • n5g-eir-eic

Usage Guidelines

Use this command to configure the EIR service name type parameters.

profile nf-client-failure nf-type eir profile failure-handling service name type message type

Specify the EIR message type parameters.

Command Mode

Exec > Global Configuration (config) > EIR Configuration (config-eir) > Failure Handling profile_name Configuration mode (config-failure-handling-profile_name ) > Failure Handling Service Name Type Configuration (config-type-service_name_type )

Syntax

message type eir_message_type 

type eir_message_type

Specify the EIR message type.

Must be one of the following:

  • EirCheckEquipmentIdentity

Usage Guidelines

Use this command to configure the EIR message type parameters.

profile nf-client-failure nf-type eir profile failure-handling service name type message type status-code httpv2

Configures HTTPv2 status codes.

Command Mode

Exec > Global Configuration

Syntax

status-code httpv2 range { code code_value | retry retry_value | action action } 

action action

Specify the action.

Must be one of the following:

  • continue : Specify to continue the session without any retry. The retry count configuration is invalid with this action.

  • retry-and-continue : Specify to retry as per the configured retry count and continue the session.

  • retry-and-ignore

  • retry-and-terminate : Specify to retry as per the configured retry count and terminate the session in case all retry fails.

  • terminate : Specify to terminate the session without any retry. Retry count configuration is invalid with this action.

code code_value

Specify the code, or a range of status codes separated by either - (hyphen) or , (comma).

Must be an integer.

-Or-

Must be a string.

retransmit-interval retransmit_interval

Specify the retransmit interval in milliseconds.

Must be an integer.

retransmit retransmit

Specify the maximum number of retransmits.

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

retry retry_value

Specify the number of times the NF service must retry before proceeding with the action.

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

Usage Guidelines

Use this command to configure HTTPv2 status codes.

profile nf-client-failure nf-type nrf

Configures NRF profile failure handling parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile nf-client-failure nf-type nrf 

Usage Guidelines

Use this command to configure NRF failure handling parameters. The CLI prompt changes to the NRF Configuration mode (config-nrf).

profile nf-client-failure nf-type nrf profile failure-handling

Configures the NRF failure handling template parameters.

Command Mode

Exec > Global Configuration (config) > NRF Configuration (config-nrf)

Syntax

profile failure-handling fh_template_name 

failure-handling fh_template_name

Specify name of the NRF failure handling template.

Must be a string.

Usage Guidelines

Use this command to configure the failure handling template parameters.

profile nf-client-failure nf-type nrf profile failure-handling service name type

Configures NRF service name type parameters.

Command Mode

Exec > Global Configuration

Syntax

type nrf_service_name_type responsetimeout response_timeout 

responsetimeout response_timeout

Specify the timeout interval in milliseconds.

Must be an integer.

Default Value: 2000.

nrf_service_name_type

Specify the NRF service name type.

Must be one of the following:

  • nrf-nfm

Usage Guidelines

Use this command to configure the NRF service name type parameters.

profile nf-client-failure nf-type nrf profile failure-handling service name type message type

Configures NRF message type parameters.

Command Mode

Exec > Global Configuration (config) > NRF Configuration (config-nrf) > Failure Handling profile_name Configuration mode (config-failure-handling-profile_name ) > Failure Handling Service Name Type Configuration (config-type-service_name_type )

Syntax

type message_type failover-enabled { false | true } re-registration-enabled { false | true } 

failover-enabled { false | true }

Specify whether to enable or disable failover to next NRF.

Must be one of the following:

  • false

  • true

Default Value: true.

re-registration-enabled { false | true }

Specify whether to enable or disable re-registration.

Must be one of the following:

  • false

  • true

Default Value: true.

type message_type

Specify the message type.

Must be one of the following:

  • Heartbeat

  • NFUpdate

  • NRFRegistration

Usage Guidelines

Use this command to configure the NRF message type parameters.

profile nf-client-failure nf-type nrf profile failure-handling service name type message type status-code httpv2

Configures HTTPv2 status code.

Command Mode

Exec > Global Configuration

Syntax

status-code httpv2 { code code_value | action action } 

action action

Specify the action.

Must be one of the following:

  • retry-next

  • retry

code code_value

Specify the code value. Ranges of status codes must be separated by either hyphen (-) or comma (,).

Must be an integer.

-Or-

Must be a string.

Usage Guidelines

Use this command to configure HTTPv2 status codes.

profile nf-client-failure nf-type pcf

Configures PCF profile failure handling parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile nf-client-failure nf-type pcf 

Usage Guidelines

Use this command to configure PCF failure handling parameters. The CLI prompt changes to the PCF Configuration mode (config-pcf).

profile nf-client-failure nf-type pcf profile failure-handling

Configures the PCF failure handling template parameters.

Command Mode

Exec > Global Configuration (config) > PCF Configuration (config-pcf)

Syntax

profile failure-handling fh_template_name 

failure-handling fh_template_name

Specify name of the PCF failure handling template.

Must be a string.

Usage Guidelines

Use this command to configure the failure handling template for PCF profile.

profile nf-client-failure nf-type pcf profile failure-handling service name type

Configures PCF service name type.

Command Mode

Exec > Global Configuration

Syntax

type pcf_service_name_type 

responsetimeout response_timeout

Specify the response timeout interval in milliseconds.

Must be an integer.

Default Value: 2000.

pcf_service_name_type

Specify the PCF service name type.

Must be one of the following:

  • npcf-am-policy-control

  • npcf-bdtpolicycontrol

  • npcf-eventexposure

  • npcf-policyauthorization

  • npcf-smpolicycontrol

  • npcf-ue-policy-control

Usage Guidelines

Use this command to configure the PCF service name type.

profile nf-client-failure nf-type pcf profile failure-handling service name type message type

Configures the PCF message type parameters.

Command Mode

Exec > Global Configuration (config) > PCF Configuration (config-pcf) > Failure Handling profile_name Configuration mode (config-failure-handling-profile_name ) > Failure Handling Service Name Type Configuration (config-type-service_name_type )

Syntax

message type pcf_message_type 

type pcf_message_type

Specify the PCF message type.

Must be one of the following:

  • PcfAmfPolicyControlCreate

  • PcfAmfPolicyControlDelete

  • PcfSmpolicycontrolCreate

  • PcfSmpolicycontrolDelete

  • PcfSmpolicycontrolUpdate

Usage Guidelines

Use this command to configure the PCF message type parameters.

profile nf-client-failure nf-type pcf profile failure-handling service name type message type status-code httpv2

Configures HTTPv2 status codes.

Command Mode

Exec > Global Configuration

Syntax

status-code httpv2 range { code code_value | retry retry_value | action action } 

action action

Specify the action.

Must be one of the following:

  • continue : Specify to continue the session without any retry. The retry count configuration is invalid with this action.

  • retry-and-continue : Specify to retry as per the configured retry count and continue the session.

  • retry-and-ignore

  • retry-and-terminate : Specify to retry as per the configured retry count and terminate the session in case all retry fails.

  • terminate : Specify to terminate the session without any retry. Retry count configuration is invalid with this action.

code code_value

Specify the code, or a range of status codes separated by either - (hyphen) or , (comma).

Must be an integer.

-Or-

Must be a string.

retransmit-interval retransmit_interval

Specify the retransmit interval in milliseconds.

Must be an integer.

retransmit retransmit

Specify the maximum number of retransmits.

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

retry retry_value

Specify the number of times the NF service must retry before proceeding with the action.

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

Usage Guidelines

Use this command to configure HTTPv2 status codes.

profile nf-client-failure nf-type sepp

Configures SEPP profile failure handling parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile nf-client-failure nf-type sepp 

Usage Guidelines

Use this command to configure SEPP failure handling parameters. The CLI prompt changes to the SEPP Configuration mode (config-epp).

profile nf-client-failure nf-type sepp profile failure-handling

Configures the SEPP failure handling template parameters.

Command Mode

Exec > Global Configuration (config) > SEPP Configuration (config-sepp)

Syntax

profile failure-handling fh_template_name 

failure-handling fh_template_name

Specify name of the SEPP failure handling template.

Must be a string.

Usage Guidelines

Use this command to configure the SEPP failure handling template for SEPP profile.

profile nf-client-failure nf-type sepp profile failure-handling service name type

Configures the SEPP service name type.

Command Mode

Exec > Global Configuration (config) > SEPP Configuration (config-sepp) > Failure Handling profile_name Configuration mode (config-failure-handling-profile_name )

Syntax

service name type sepp_service_name_type [ responsetimeout response_timeout ] 

responsetimeout response_timeout

Specify the response timeout interval in milliseconds.

Must be an integer.

Default Value: 2000.

type sepp_service_name_type

Specify the SEPP service name type.

Must be one of the following:

  • nsmf-pdusession

Usage Guidelines

Use this command to configure the SEPP service name type.

profile nf-client-failure nf-type sepp profile failure-handling service name type message type

Configures the SEPP message type parameters.

Command Mode

Exec > Global Configuration (config) > SEPP Configuration (config-sepp) > Failure Handling profile_name Configuration mode (config-failure-handling-profile_name ) > Failure Handling Service Name Type Configuration (config-type-service_name_type )

Syntax

message type sepp_message_type 

type sepp_message_type

Specify the SEPP message type.

Must be one of the following:

  • HsmfPduSessionNotify

  • HsmfPduSessionUpdate

  • VsmfPduSessionCreate

  • VsmfPduSessionRelease

  • VsmfPduSessionUpdate

Usage Guidelines

Use this command to configure the SEPP message type parameters.

profile nf-client-failure nf-type sepp profile failure-handling service name type message type status-code httpv2

Configures HTTPv2 status codes.

Command Mode

Exec > Global Configuration

Syntax

status-code httpv2 range { code code_value | retry retry_value | action action } 

action action

Specify the action.

Must be one of the following:

  • continue : Specify to continue the session without any retry. The retry count configuration is invalid with this action.

  • retry-and-continue : Specify to retry as per the configured retry count and continue the session.

  • retry-and-ignore

  • retry-and-terminate : Specify to retry as per the configured retry count and terminate the session in case all retry fails.

  • terminate : Specify to terminate the session without any retry. Retry count configuration is invalid with this action.

code code_value

Specify the code, or a range of status codes separated by either - (hyphen) or , (comma).

Must be an integer.

-Or-

Must be a string.

retransmit-interval retransmit_interval

Specify the retransmit interval in milliseconds.

Must be an integer.

retransmit retransmit

Specify the maximum number of retransmits.

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

retry retry_value

Specify the number of times the NF service must retry before proceeding with the action.

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

Usage Guidelines

Use this command to configure HTTPv2 status codes.

profile nf-client-failure nf-type smf

Configures SMF profile failure handling parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile nf-client-failure nf-type smf 

Usage Guidelines

Use this command to configure SMF failure handling parameters. The CLI prompt changes to the SMF Configuration mode (config-smf).

profile nf-client-failure nf-type smf profile failure-handling

Configures the SMF failure handling template parameters.

Command Mode

Exec > Global Configuration (config) > SMF Configuration (config-smf)

Syntax

profile failure-handling fh_template_name 

failure-handling fh_template_name

Specify name of the SMF failure handling template.

Must be a string.

Usage Guidelines

Use this command to configure the SMF failure handling template for SMF profile.

profile nf-client-failure nf-type smf profile failure-handling service name type

Configures the SMF service name type.

Command Mode

Exec > Global Configuration (config) > SMF Configuration (config-smf) > Failure Handling profile_name Configuration mode (config-failure-handling-profile_name )

Syntax

service name type smf_service_name_type 

responsetimeout response_timeout

Specify the response timeout interval in milliseconds.

Must be an integer.

Default Value: 2000.

type smf_service_name_type

Specify the SMF service name type.

Must be one of the following:

  • nsmf-pdusession

Usage Guidelines

Use this command to configure the SMF service name type.

profile nf-client-failure nf-type smf profile failure-handling service name type message type status-code httpv2

Configures HTTPv2 status codes.

Command Mode

Exec > Global Configuration

Syntax

status-code httpv2 range { code code_value | retry retry_value | action action } 

action action

Specify the action.

Must be one of the following:

  • continue : Specify to continue the session without any retry. The retry count configuration is invalid with this action.

  • retry-and-continue : Specify to retry as per the configured retry count and continue the session.

  • retry-and-ignore

  • retry-and-terminate : Specify to retry as per the configured retry count and terminate the session in case all retry fails.

  • terminate : Specify to terminate the session without any retry. Retry count configuration is invalid with this action.

code code_value

Specify the code, or a range of status codes separated by either - (hyphen) or , (comma).

Must be an integer.

-Or-

Must be a string.

retransmit-interval retransmit_interval

Specify the retransmit interval in milliseconds.

Must be an integer.

retransmit retransmit

Specify the maximum number of retransmits.

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

retry retry_value

Specify the number of times the NF service must retry before proceeding with the action.

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

Usage Guidelines

Use this command to configure HTTPv2 status codes.

profile nf-client-failure nf-type udm

Configures UDM profile failure handling parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile nf-client-failure nf-type udm 

Usage Guidelines

Use this command to configure UDM failure handling parameters. The CLI prompt changes to the UDM Configuration mode (config-udm).

profile nf-client-failure nf-type udm profile failure-handling

Configures the UDM failure handling template parameters.

Command Mode

Exec > Global Configuration (config) > UDM Configuration (config-udm)

Syntax

profile failure-handling fh_template_name 

failure-handling fh_template_name

Specify name of the UDM failure handling template.

Must be a string.

Usage Guidelines

Use this command to configure the failure handling template for UDM profile.

profile nf-client-failure nf-type udm profile failure-handling service name type

Configures UDM service name type.

Command Mode

Exec > Global Configuration (config) > UDM Configuration (config-udm) > Failure Handling profile_name Configuration mode (config-failure-handling-profile_name )

Syntax

type udm_service_name_type [ responsetimeout response_timeout ] 

responsetimeout response_timeout

Specify the response timeout interval in milliseconds.

Must be an integer.

Default Value: 2000.

udm_service_name_type

Specify the UDM service name type.

Must be one of the following:

  • nudm-ee

  • nudm-pp

  • nudm-sdm

  • nudm-ueau

  • nudm-uecm

Usage Guidelines

Use this command to configure the UDM service name type.

profile nf-client-failure nf-type udm profile failure-handling service name type message type

Configures the UDM message type parameters.

Command Mode

Exec > Global Configuration (config) > UDM Configuration (config-udm) > Failure Handling profile_name Configuration mode (config-failure-handling-profile_name ) > Failure Handling Service Name Type Configuration (config-type-service_name_type )

Syntax

message type udm_message_type 

type udm_message_type

Specify the UDM message type.

Must be one of the following:

  • UdmDeRegistrationReq

  • UdmRegistrationReq

  • UdmSdmGetUESMSubscriptionData

  • UdmSdmSubscribeToNotification

  • UdmSdmUnsubscribeToNotification

  • UdmSubscriptionReq

  • UdmUecmRegisterSMF

  • UdmUecmUnregisterSMF

  • UdmUnSubscriptionReq

Usage Guidelines

Use this command to configure the UDM message type parameters.

profile nf-client-failure nf-type udm profile failure-handling service name type message type status-code httpv2

Configures HTTPv2 status codes.

Command Mode

Exec > Global Configuration

Syntax

status-code httpv2 range { code code_value | retry retry_value | action action } 

action action

Specify the action.

Must be one of the following:

  • continue : Specify to continue the session without any retry. The retry count configuration is invalid with this action.

  • retry-and-continue : Specify to retry as per the configured retry count and continue the session.

  • retry-and-ignore

  • retry-and-terminate : Specify to retry as per the configured retry count and terminate the session in case all retry fails.

  • terminate : Specify to terminate the session without any retry. Retry count configuration is invalid with this action.

code code_value

Specify the code, or a range of status codes separated by either - (hyphen) or , (comma).

Must be an integer.

-Or-

Must be a string.

retransmit-interval retransmit_interval

Specify the retransmit interval in milliseconds.

Must be an integer.

retransmit retransmit

Specify the maximum number of retransmits.

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

retry retry_value

Specify the number of times the NF service must retry before proceeding with the action.

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

Usage Guidelines

Use this command to configure HTTPv2 status codes.

profile nf-pair nf-type

Configures the NF client pair type parameter.

Command Mode

Exec > Global Configuration (config)

Syntax

profile nf-pair nf-type nf_type [ [ limit max_discovery_profiles ] [ max-payload-size max_payload_size ] [ nrf-discovery-group group_name ] ] 

limit max_discovery_profiles

Specify the maximum number of discovery profiles that NRF can send.

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

Default Value: 10.

max-payload-size max_payload_size

Specify the maximum payload size of the discovery response.

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

Default Value: 124.

nf-type nf_type

Specify the NF client pair type.

Must be one of the following:

  • 5G_EIR

  • AF

  • AMF

  • AUSF

  • BSF

  • CHF

  • GMLC

  • LMF

  • N3IWF

  • NEF

  • NRF

  • NSSF

  • NWDAF

  • PCF

  • SEPP

  • SMF

  • SMSF

  • UDM

  • UDR

  • UDSF

  • UPF

nrf-discovery-group group_name

Specify name of the NRF discovery group.

Must be a string.

Usage Guidelines

Configures NF client pair parameters. Use this command to configure the NF client pair type parameter.

profile nf-pair nf-type cache invalidation true

Configures the invalidation cache for "true" case.

Command Mode

Exec > Global Configuration (config) > NF Type Configuration (config-nf-type-nf_type )

Syntax

cache invalidation { false | true [ timeout timeout_duration ] } 

timeout timeout_duration

Specify the invalidation cache timeout duration in milliseconds.

Must be an integer.

Default Value: 0.

true

True condition.

Usage Guidelines

Use this command to configure the true case parameters for invaldation cache.

profile nf-pair nf-type locality

Configures client locality parameter.

Command Mode

Exec > Global Configuration (config) > NF Type Configuration (config-nf-type-nf_type )

Syntax

locality { client locality_name | geo-server locality_name | preferred-server locality_name } 

client locality_name

Specify the Client Locality information.

Must be a string.

geo-server locality_name

Specify the Geo Service Locality information.

Must be a string.

preferred-server locality_name

Specify the preferred server locality information.

Must be a string.

Usage Guidelines

Use this command to configure the client locality parameter.

profile overload

Configures overload protection profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile overload profile_name 

overload profile_name

Specify name of the overload protection profile.

Must be a string.

Usage Guidelines

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

You can configure a maximum of one element with this command.

profile overload node-level

Configures Overload profile's node-level parameters.

Command Mode

Exec > Global Configuration (config) > Overload Profile Configuration (config-overload-profile_name )

Syntax

node-level 

Usage Guidelines

Use this command to configure the overload profile's node-level parameters. The CLI prompt chnages to the Node-level Configuration mode (config-node-level).

profile overload node-level advertise

Configures the advertising action.

Command Mode

Exec > Global Configuration (config) > Overload Profile Configuration (config-overload-profile_name ) > Node Level Configuration (config-node-level)

Syntax

advertise { [ interval advertising_interval ] [ change-factor change_factor ] [ validity-period validity_period ] } 

change-factor change_factor

Specify the minimum change between current OCI and last indicated OCI, after which only advertising should happen.

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

Default Value: 5.

interval advertising_interval

Specify the advertising interval in seconds.

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

Default Value: 300.

validity-period validity_period

Specify the validity period of the advertised OCI value in seconds.

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

Default Value: 600.

Usage Guidelines

Use this command to configure the advertising action.

profile overload node-level interface

Configures the list of interfaces.

Command Mode

Exec > Global Configuration (config) > Overload Profile Configuration (config-overload-profile_name ) > Node Level Configuration (config-node-level)

Syntax

interface interface_type [ overloaded-action overloaded_action ] 

interface interface_type

Specify the type of the interface.

Must be one of the following:

  • gtpc

overloaded-action overloaded_action

Specify the action on the interface in overloaded state.

Must be one of the following:

  • advertise

Usage Guidelines

Use this command to configure the list of interfaces.

profile overload node-level reduction-metric

Configures the percentage reduction metric configuration.

Command Mode

Exec > Global Configuration (config) > Overload Profile Configuration (config-overload-profile_name ) > Node Level Configuration (config-node-level)

Syntax

reduction-metric { [ minimum minimum_reduction ] [ maximum maximum_reduction ] } 

maximum maximum_reduction

Specify the percentage of reduction in tandem with tolerance maximum configuration. Maximum reduction must be greater than minimum reduction.

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

Default Value: 100.

minimum minimum_reduction

Specify the percentage of reduction in tandem with tolerance minimum configuration. Minimum reduction must be lesser than maximum reduction.

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

Default Value: 10.

Usage Guidelines

Use this command to configure the Percentage Reduction Metric configuration.

profile overload node-level tolerance

Configures the percentage tolerance level configuration.

Command Mode

Exec > Global Configuration (config) > Overload Profile Configuration (config-overload-profile_name ) > Node-level Configuration (config-node-level)

Syntax

tolerance { [ minimum minimum_tolerance ] [ maximum maximum_tolerance ] } 

maximum maximum_tolerance

Specify the tolerance level above which the system is considered to be in self-protection state. Maximum tolerance must be greater than minimum tolerance.

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

Default Value: 95.

minimum minimum_tolerance

Specify the tolerance level below which the system is considered to be in normal state. Minimum tolerance must be lesser than maximum tolerance.

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

Default Value: 80.

Usage Guidelines

Use this command to configure the percentage tolerance level configuration.

profile overload overload-exclude-profile

Configures excluding profiles for overload scenarios.

Command Mode

Exec > Global Configuration (config) > Overload Profile Configuration (config-overload-profile_name )

Syntax

overload-exclude-profile self-protection exclude_profile_name peer-overload exclude_profile_name 

peer-overload exclude_profile_name

Specify to exclude profile for peer overload.

Must be a string.

self-protection exclude_profile_name

Specify to exclude profile for self protection.

Must be a string.

Usage Guidelines

Use this command to configure excluding profiles for overload scenarios.

profile overload peer-level interface

Configures the list of interfaces.

Command Mode

Exec > Global Configuration

Syntax

interface type interface_type 

type interface_type

Specify the interface type.

Must be one of the following:

  • gtpc

Usage Guidelines

Use this command to configure the list of interfaces.

profile overload peer-level interface action throttle

Configures the throttling action.

Command Mode

Exec > Global Configuration

Syntax

throttle duration throttling_duration threshold max_messages 

duration throttling_duration

Specify the duration for which messages must be throttled.

Must be an integer.

threshold max_messages

Specify the maximum percentage of messages to be allowed during throttling.

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

Usage Guidelines

Use this command to configure the throttling action.

profile overload peer-level message-prioritization

Configures peer-level message prioritization parameter.

Command Mode

Exec > Global Configuration

Syntax

peer-level message-prioritization group1 message_priority group2 message_priority group3 message_priority group4 message_priority 

group1 message_priority

Specify the message prioritization for group 1.

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

Default Value: 50.

group2 message_priority

Specify the message prioritization for group 2.

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

Default Value: 50.

Usage Guidelines

Use this command to configure the peer-level message prioritization parameters. The total of all weights must be 100. That is, "group1 + group2 + group3 + group4 = 100".

profile overload-exclude

Configures the list of exclude overloads.

Command Mode

Exec > Global Configuration (config)

Syntax

profile overload-exclude exclude_profile_name [ [ arp-list arp_list ] [ dnn-list dnn_list ] [ procedure-list procedures_list ] [ qi5-list qi5_list ] ] 

arp-list arp_list

Specify the Allocation and Retention Priorities to be excluded from throttling decisions.

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

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

dnn-list dnn_list

Specify the DNNs to be excluded from throttling decisions.

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

Must be a string.

overload-exclude exclude_profile_name

Specify the name of the exclude profile.

Must be a string.

procedure-list procedures_list

Specify the procedures to be excluded from throttling decisions. Applicable only for Self-Protection.

Must be one of the following:

  • session-delete

qi5-list qi5_list

Specify the 5G QoS Identifiers to be excluded from throttling decisions.

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

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

Usage Guidelines

Use this command to configure the list of exclude overloads.

profile overload-exclude message-priority

Configures the message priorities to be excluded from throttling decisions.

Command Mode

Exec > Global Configuration (config) > Overload Exclude Profile Configuration (config-overload-exclude-profile_name )

Syntax

message-priority interface_type upto message_priority_upto 

message-priority interface_type

Specify the interface type.

Must be one of the following:

  • s5

upto message_priority_upto

Specify the message priority upto which must be excluded from throttling decisions.

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

Usage Guidelines

Use this command to configure the message priorities to be excluded from throttling decisions.

profile pcscf

Configures the P-CSCF profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile pcscf profile_name 

pcscf profile_name

Specify name of the P-CSCF profile.

Must be a string.

Usage Guidelines

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

profile pcscf fqdn

Configures the P-CSCF server's Fully Qualified Domain Name (FQDN).

Command Mode

Exec > Global Configuration (config) > P-CSCF Profile Configuration (config-pcscf-profile_name )

Syntax

fqdn fqdn 

fqdn fqdn

Specify the P-CSCF server's FQDN.

Must be a string.

Usage Guidelines

Use this command to configure the P-CSCF server's FQDN.

profile pcscf pcscf-selection

Configures the P-CSCF server selection algorithm.

Command Mode

Exec > Global Configuration (config) > P-CSCF Profile Configuration (config-pcscf-profile_name )

Syntax

pcscf-selection algorithm 

pcscf-selection algorithm

Specify the P-CSCF server selection algorithm.

Must be one of the following:

  • round-robin

Default Value: round-robin.

Usage Guidelines

Use this command to configure the P-CSCF server selection method.

profile pcscf pcscf-restoration trigger

Configures SMF to reselect active P-CSCF addresses for UE.

Command Mode

Exec > Global Configuration (config) > P-CSCF Profile Configuration (config-pcscf-profile_name )

Syntax

pcscf-restoration trigger [ UDM ] [ action [ mark-down ] ] 

pcscf-restoration trigger [ UDM ]

Enables UDM triggered P-CSCF restoration and reselection. trigger [ UDM ] specifies that the restoration configuration is triggered by UDM.

[ action [ mark-down ] ]

It is optional and if configured, it can only have [ mark-down ] as the option.

Usage Guidelines

Use this command to configure the P-CSCF to select active P-CSCF addresses post a P-CSCF address failure.

profile pcscf v4-list

Configures the P-CSCF IPv4 server details in the P-CSCF profile.

Command Mode

Exec > Global Configuration (config) > P-CSCF Profile Configuration (config-pcscf-profile_name )

Syntax

v4-list 

Usage Guidelines

Use this command to configure the P-CSCF IPv4 server details in the P-CSCF profile. The CLI prompt changes to the V4 List Configuration mode (config-v4-list).

profile pcscf v4-list list-entry

Configures the P-CSCF IPv4 server list entries.

Command Mode

Exec > Global Configuration (config) > P-CSCF Profile Configuration (config-pcscf-profile_name ) > V4 List Configuration (config-v4-list)

Syntax

precedence precedence_number 

precedence precedence_number

Specify the precedence number for P-CSCF IPv4 server configuration.

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

Usage Guidelines

Configures the P-CSCF IPv4 server details in the P-CSCF profile. Use this command to configure the P-CSCF IPv4 server list entries.

profile pcscf v4-list list-entry primary

Configures the IPv4 address of the primary P-CSCF server.

Command Mode

Exec > Global Configuration

Syntax

primary ipv4 ipv4_address 

ipv4 ipv4_address

Specify the IPv4 address of the primary P-CSCF server in dotted-decimal notation.

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

Usage Guidelines

Use this command to configure the IPv4 address of the primary P-CSCF server.

Example

The following command configures the primary P-CSCF server with IPv4 address 30.22.21.44:
primary ipv4 30.22.21.44 

profile pcscf v4-list list-entry secondary

Configures the IPv4 address of the secondary P-CSCF server.

Command Mode

Exec > Global Configuration

Syntax

secondary ipv4 ipv4_address 

ipv4 ipv4_address

Specify the IPv4 address of the secondary P-CSCF server in dotted-decimal notation.

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

Usage Guidelines

Use this to command configure the IPv4 address of the secondary P-CSCF server.

Example

The following command configures the secondary P-CSCF server with IPv4 address 30.22.21.44:
secondary ipv4 30.22.21.44 

profile pcscf v4-list list-entry tertiary

Configures the IPv4 address of the tertiary P-CSCF server.

Command Mode

Exec > Global Configuration

Syntax

tertiary ipv4 ipv4_address 

ipv4 ipv4_address

Specify the IPv4 address of the tertiary P-CSCF server in dotted-decimal notation.

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

Usage Guidelines

Use this to command configure the IPv4 address of the tertiary P-CSCF server.

Example

The following command configures the tertiary P-CSCF server with IPv4 address 30.22.21.44:
tertiary ipv4 30.22.21.44 

profile pcscf v4v6-list

Configures the P-CSCF IPv4v6 server details.

Command Mode

Exec > Global Configuration (config) > P-CSCF Profile Configuration (config-pcscf-profile_name )

Syntax

v4v6-list 

Usage Guidelines

Use this command to configure the P-CSCF IPv4v6 server details in the P-CSCF profile. The CLI prompt changes to the v4v6 List Configuration Mode (config-v4v6-list).

profile pcscf v4v6-list list-entry

Configures the P-CSCF IPv4v6 server list entries.

Command Mode

Exec > Global Configuration (config) > P-CSCF Profile Configuration (config-pcscf-profile_name ) > v4v6 Configuration Mode (config-v4v6-list)

Syntax

precedence precedence_number 

precedence precedence_number

Specify the precedence of entries in the P-CSCF IPv4v6 server list.

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

Usage Guidelines

Use this command to configure the P-CSCF IPv4v6 server list entries.

profile pcscf v4v6-list list-entry primary

Configures the IPv4v6 address of the primary P-CSCF server.

Command Mode

Exec > Global Configuration

Syntax

primary ipv4 ipv4_address ipv6 ipv6_address 

ipv4 ipv4_address

Specify the IPv4 address of the primary P-CSCF server in dotted-decimal notation.

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

ipv6 ipv6_address

Specify the IPv6 address of the primary P-CSCF server in colon-separated hexadecimal notation.

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

Usage Guidelines

Use this command to configure the IPv4v6 address of the primary P-CSCF server.

Example

The following command configures the primary P-CSCF server with IPv4 address as 30.22.21.44 and IPv6 address as 123:345:456::6578:
primary ipv4 30.22.21.44 ipv6 123:345:456::6578 

profile pcscf v4v6-list list-entry secondary

Configures the IPv4v6 address of the secondary P-CSCF server.

Command Mode

Exec > Global Configuration

Syntax

secondary { [ ipv4 ipv4_address ] [ ipv6 ipv6_address ] } 

ipv4 ipv4_address

Specify the IPv4 address of the secondary P-CSCF server in dotted-decimal notation.

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

ipv6 ipv6_address

Specify the IPv6 address of the secondary P-CSCF server in colon-separated hexadecimal notation.

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

Usage Guidelines

Use this command to configure the IPv4v6 address of the secondary P-CSCF server.

Example

The following command configures the secondary P-CSCF server with IPv4 address as 30.22.21.44 and IPv6 address as 123:345:456::6578:
secondary ipv4 30.22.21.44 ipv6 123:345:456::6578 

profile pcscf v4v6-list list-entry tertiary

Configures the IPv4v6 address of the tertiary P-CSCF server.

Command Mode

Exec > Global Configuration

Syntax

tertiary { [ ipv4 ipv4_address ] [ ipv6 ipv6_address ] } 

ipv4 ipv4_address

Specify the IPv4 address of the tertiary P-CSCF server in dotted-decimal notation.

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

ipv6 ipv6_address

Specify the IPv6 address of the tertiary P-CSCF server in colon-separated hexadecimal notation.

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

Usage Guidelines

Use this command to configure the IPv4v6 address of the tertiary P-CSCF server.

Example

The following command configures the tertiary P-CSCF server with IPv4 address as 30.22.21.44 and IPv6 address as 123:345:456::6578:
tertiary ipv4 30.22.21.44 ipv6 123:345:456::6578 

profile pcscf v6-list

Configures the P-CSCF IPv6 server details.

Command Mode

Exec > Global Configuration (config) > P-CSCF Profile Configuration (config-pcscf-profile_name )

Syntax

v6-list 

Usage Guidelines

Use this command to configure the P-CSCF IPv6 server details in the P-CSCF profile. The CLI prompt changes to the V6 List Configuration mode (config-v6-list).

profile pcscf v6-list list-entry

Configures the P-CSCF IPv6 server list entries.

Command Mode

Exec > Global Configuration (config) > P-CSCF Profile Configuration (config-pcscf-profile_name ) > V6 List Configuration (config-v6-list)

Syntax

precedence precedence_level 

precedence precedence_level

Specify the precedence of entries in the P-CSCF IPv6 server list.

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

Usage Guidelines

Use this command to configure the P-CSCF IPv6 server list entries.

profile pcscf v6-list list-entry primary

Configures the IPv6 address of the primary P-CSCF server.

Command Mode

Exec > Global Configuration (config) > P-CSCF Profile Configuration (config-pcscf-profile_name ) > V6 List Configuration (config-v6-list)

Syntax

primary ipv6 ipv6_address 

ipv6 ipv6_address

Specify the IPv6 address of the primary P-CSCF server in colon-separated hexadecimal notation.

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

Usage Guidelines

Use this command to configure the IPv6 address of the primary P-CSCF server.

Example

The following command configures the primary P-CSCF server with IPv6 address 123:345:456::6578:
primary ipv6 123:345:456::6578 

profile pcscf v6-list list-entry secondary

Configures the IPv6 address of the secondary P-CSCF server.

Command Mode

Exec > Global Configuration

Syntax

secondary ipv6 ipv6_address 

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 chapter.

Usage Guidelines

Use this command to configure the IPv6 address of the secondary P-CSCF server.

Example

The following command configures the secondary P-CSCF server with IPv6 address 123:345:456::6578:
secondary ipv6 123:345:456::6578 

profile pcscf v6-list list-entry tertiary

Configures the IPv6 address of the tertiary P-CSCF server.

Command Mode

Exec > Global Configuration

Syntax

tertiary ipv6 ipv6_address 

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 chapter.

Usage Guidelines

Use this command to configure the IPv6 address of the tertiary P-CSCF server.

Example

The following command configures the tertiary P-CSCF server with the IPv6 address 123:345:456::6578:
tertiary ipv6 123:345:456::6578 

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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  message-priority-profile profile_name   [ [ priority qi_priority ] [ qi5 qos_id ] ] arp-priority-level arp_value message-priority-profile profile_name 

priority qi_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.

message-priority-profile profile_name

Associates message priority profile to QoS profile.

qi5 qos_id

Specify the ID for the authorized QoS parameters.

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

arp-priority-level arp_value message-priority-profile profile_name : Message priority profile associated to ARP. Specify the ARP value in the range between 1 to 255.

The Message priority profile associated to QCI or ARP or QoS profile, or message priority profile associated to WPS are negotiated to find the one which has the better priority.

vplmn-qos-negotiation { false | true }

Specify whether to enable or disable configured QoS to negotiate for defalut flow.

Must be one of the following:

  • false

  • true

Default Value: false.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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 qos qosflow qi5

Configures Qos flow parameters for 5QI/ARP values.

Command Mode

Exec > Global Configuration (config)

Syntax

qosflow qi5  qci_value 
        arp-priority-level arp_value  
               message-priority-profile profile_name  
      message-priority-profile profile_name  

qosflow qi5 qci_value

Specify the QCI value.

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


Note


If there is no message priority profile associated to a default bearer/flow qci/arp, then message priority value is considered from message priority profile that is associated to a QoS profile for the IMS and emergency calls. When a dedicated bearer/flow gets created, message priority is considered from message priority profile associated to the qci/arp depending on the configuration.

Usage Guidelines

Use this command to configure the Qos flow parameters for 5QI/ARP values.

profile qos qosflow qi5 arp-priority-level

Configures the ARP priority level.

Command Mode

Exec > Global Configuration (config)

Syntax

arp-priority-level arp-value arp_value 

arp-value arp_value

Specify the ARP value.

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

Usage Guidelines

Use this command to configure the the ARP priority level.

profile qos qosflow qi5 arp-priority-level dscp-info downlink encaps-header

Configures the DSCP value to be applied to encaps header.

Command Mode

Exec > Global Configuration (config)

Syntax

encaps-header dscp_for_encaps_header 

dscp-marking dscp_for_packets

Specify the DSCP value to be applied to packets. For example, 0x3F.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

encap-copy-inner

Specify to copy inner DSCP to outer.

encap-copy-outer

Specify to copy outer DSCP to inner.

encaps-header dscp_for_encaps_header

Specify the DSCP value to be applied to encaps header.

Usage Guidelines

Configures downlink/uplink DSCP information. Use this command to configure the DSCP value to be applied to encaps header.

profile qos qosflow qi5 arp-priority-level dscp-info downlink user-datagram

Configures the DSCP value to be applied to user datagram.

Command Mode

Exec > Global Configuration (config)

Syntax

user-datagram ud-dscp dscp_for_packets ud-encaps-header dscp_for_encaps_header 

dscp-marking dscp_for_packets

Specify the DSCP value to be applied to packets. For example, 0x3F.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

encap-copy-inner

Specify to copy inner DSCP to outer.

encap-copy-outer

Specify to copy outer DSCP to inner.

ud-dscp dscp_for_packets

Specify the DSCP value to be applied to packets. For example, 0x3F.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

ud-encaps-header dscp_for_encaps_header

Specify the DSCP value to be applied to encaps header.

Usage Guidelines

Use this command to the DSCP value to be applied to user datagram.

profile qos qosflow qi5 arp-priority-level dscp-info uplink encaps-header

Configures the DSCP value to be applied to encaps header.

Command Mode

Exec > Global Configuration (config)

Syntax

encaps-header dscp_for_encaps_header 

dscp-marking dscp_for_packets

Specify the DSCP value to be applied to packets. For example, 0x3F.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

encap-copy-inner

Specify to copy inner DSCP to outer.

encap-copy-outer

Specify to copy outer DSCP to inner.

encaps-header dscp_for_encaps_header

Specify the DSCP value to be applied to encaps header.

Usage Guidelines

Configures downlink/uplink DSCP information. Use this command to configure the DSCP value to be applied to encaps header.

profile qos qosflow qi5 arp-priority-level dscp-info uplink user-datagram

Configures the DSCP value to be applied to user datagram.

Command Mode

Exec > Global Configuration (config)

Syntax

user-datagram ud-dscp dscp_for_packets ud-encaps-header dscp_for_encaps_header 

dscp-marking dscp_for_packets

Specify the DSCP value to be applied to packets. For example, 0x3F.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

encap-copy-inner

Specify to copy inner DSCP to outer.

encap-copy-outer

Specify to copy outer DSCP to inner.

ud-dscp dscp_for_packets

Specify the DSCP value to be applied to packets. For example, 0x3F.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

ud-encaps-header dscp_for_encaps_header

Specify the DSCP value to be applied to encaps header.

Usage Guidelines

Use this command to the DSCP value to be applied to user datagram.

profile qos qosflow qi5 arp-priority-level flow-parameter gfbr

Configures the Guaranted Bit Rate (GFBR).

Command Mode

Exec > Global Configuration (config)

Syntax

flow-parameter gfbr { [ ul gfbr_uplink_threshold ] [ dl gfbr_downlink_threshold ] } 

dl gfbr_downlink_threshold

Specify the GFBR downlink threshold.

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

ul gfbr_uplink_threshold

Specify the GFBR uplink threshold.

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

Usage Guidelines

Use this command to configure the GFBR.

profile qos qosflow qi5 arp-priority-level flow-parameter mfbr

Configures the Maximum Bit Rate (MFBR).

Command Mode

Exec > Global Configuration (config)

Syntax

flow-parameter mfbr { [ ul mfbr_uplink_threshold ] [ dl mfbr_downlink_threshold ] } 

dl mfbr_downlink_threshold

Specify the MFBR downlink threshold.

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

ul mfbr_uplink_threshold

Specify the MFBR uplink threshold.

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

Usage Guidelines

Use this command to configure the MFBR.

profile qos qosflow qi5 dscp-info downlink encaps-header

Configures the DSCP value to be applied to encaps header.

Command Mode

Exec > Global Configuration (config)

Syntax

encaps-header dscp_for_encaps_header 

dscp-marking dscp_for_packets

Specify the DSCP value to be applied to packets. For example, 0x3F.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

encap-copy-inner

Specify to copy inner DSCP to outer.

encap-copy-outer

Specify to copy outer DSCP to inner.

encaps-header dscp_for_encaps_header

Specify the DSCP value to be applied to encaps header.

Usage Guidelines

Configures downlink/uplink DSCP information. Use this command to configure the DSCP value to be applied to encaps header.

profile qos qosflow qi5 dscp-info downlink user-datagram

Configures the DSCP value to be applied to user datagram.

Command Mode

Exec > Global Configuration (config)

Syntax

user-datagram ud-dscp dscp_for_packets ud-encaps-header dscp_for_encaps_header 

dscp-marking dscp_for_packets

Specify the DSCP value to be applied to packets. For example, 0x3F.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

encap-copy-inner

Specify to copy inner DSCP to outer.

encap-copy-outer

Specify to copy outer DSCP to inner.

ud-dscp dscp_for_packets

Specify the DSCP value to be applied to packets. For example, 0x3F.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

ud-encaps-header dscp_for_encaps_header

Specify the DSCP value to be applied to encaps header.

Usage Guidelines

Use this command to the DSCP value to be applied to user datagram.

profile qos qosflow qi5 dscp-info uplink encaps-header

Configures the DSCP value to be applied to encaps header.

Command Mode

Exec > Global Configuration (config)

Syntax

encaps-header dscp_for_encaps_header 

dscp-marking dscp_for_packets

Specify the DSCP value to be applied to packets. For example, 0x3F.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

encap-copy-inner

Specify to copy inner DSCP to outer.

encap-copy-outer

Specify to copy outer DSCP to inner.

encaps-header dscp_for_encaps_header

Specify the DSCP value to be applied to encaps header.

Usage Guidelines

Configures downlink/uplink DSCP information. Use this command to configure the DSCP value to be applied to encaps header.

profile qos qosflow qi5 dscp-info uplink user-datagram

Configures the DSCP value to be applied to user datagram.

Command Mode

Exec > Global Configuration (config)

Syntax

user-datagram ud-dscp dscp_for_packets ud-encaps-header dscp_for_encaps_header 

dscp-marking dscp_for_packets

Specify the DSCP value to be applied to packets. For example, 0x3F.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

encap-copy-inner

Specify to copy inner DSCP to outer.

encap-copy-outer

Specify to copy outer DSCP to inner.

ud-dscp dscp_for_packets

Specify the DSCP value to be applied to packets. For example, 0x3F.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

ud-encaps-header dscp_for_encaps_header

Specify the DSCP value to be applied to encaps header.

Usage Guidelines

Use this command to the DSCP value to be applied to user datagram.

profile qos qosflow qi5 flow-parameter gfbr

Configures the Guaranted Bit Rate (GFBR).

Command Mode

Exec > Global Configuration (config)

Syntax

flow-parameter gfbr { [ ul gfbr_uplink_threshold ] [ dl gfbr_downlink_threshold ] } 

dl gfbr_downlink_threshold

Specify the GFBR downlink threshold.

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

ul gfbr_uplink_threshold

Specify the GFBR uplink threshold.

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

Usage Guidelines

Use this command to configure the GFBR.

profile qos qosflow qi5 flow-parameter mfbr

Configures the Maximum Bit Rate (MFBR).

Command Mode

Exec > Global Configuration (config)

Syntax

flow-parameter mfbr { [ ul mfbr_uplink_threshold ] [ dl mfbr_downlink_threshold ] } 

dl mfbr_downlink_threshold

Specify the MFBR downlink threshold.

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

ul mfbr_uplink_threshold

Specify the MFBR uplink threshold.

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

Usage Guidelines

Use this command to configure the MFBR.

profile radius

Configures RADIUS client profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile radius [ [ algorithm server_selection_algorithm ] [ deadtime deadtime_interval ] [ enable-packet-dump ] [ dictionary  dictionary_name  ] [ max-retry max_retries ] [ timeout timeout_interval ] ] 

algorithm server_selection_algorithm

Specify the algorithm for selecting the RADIUS server. Default Value: first-server.

Must be one of the following:

  • first-server

  • round-robin

deadtime deadtime_interval

Specify the time interval, in minutes, between the RADIUS server being marked unreachable and connection can be re-attempted.

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

enable-packet-dump

Specify to enable packet dump.

dictionary

Specify the dictionary name as ISE.

max_retries

Specify the maximum number of times the system will attempt retry with the RADIUS server.

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

timeout_interval

Specify the time interval to elapse for a response from the RADIUS server before re-transmitting.

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

Usage Guidelines

Use this command to configure RADIUS client profile. The CLI prompt changes to the RADIUS Configuration mode (config-radius).

profile radius accounting

Configures RADIUS accounting parameters.

Command Mode

Exec > Global Configuration

Syntax

accounting options 

algorithm server_selection_algorithm

Specify the algorithm for selecting the RADIUS server. Default Value: first-server.

Must be one of the following:

  • first-server

  • round-robin

deadtime deadtime_interval

Specify the time interval, in minutes, between the RADIUS server being marked unreachable and connection can be re-attempted.

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

max_retries

Specify the maximum number of times the system will attempt retry with the RADIUS server.

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

timeout_interval

Specify the time interval to elapse for a response from the RADIUS server before re-transmitting.

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

Usage Guidelines

Use this command to configure the RADIUS accounting parameters.

profile radius accounting attribute

Configures RADIUS identification parameters.

Command Mode

Exec > Global Configuration (config) > RADIUS Configuration (config-radius)

Syntax

attribute { nas-identifier nas_id | nas-ip aaa_nas_ipv4_address } 

nas-identifier nas_identifier

Specify the attribute name by which the system will be identified in Auth or Accounting Request messages.

Must be a string in the fmtstr pattern. For information on the fmtstr pattern, see the Input Pattern Types chapter.

nas-identifier nas_identifier

Specify the attribute name by which the system will be identified in Auth or Accounting Request messages.

Must be a string in the fmtstr pattern. For information on the fmtstr pattern, see the Input Pattern Types chapter.

nas-ip aaa_nas_ipv4_address

Specify the AAA NAS IPv4 address.

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

-Or-

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

Usage Guidelines

Use this command to configure RADIUS identification parameters.

profile radius accounting attribute instance

Configures instance configuration parameters.

Command Mode

Exec > Global Configuration > RADIUS Configuration (config-radius)

Syntax

attribute instance instance_id nas-ip aaa_nas_ipv4_address 

instance instance_id

Specify the instance ID.

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

nas-identifier nas_identifier

Specify the attribute name by which the system will be identified in Auth or Accounting Request messages.

Must be a string in the fmtstr pattern. For information on the fmtstr pattern, see the Input Pattern Types chapter.

instance instance_id

Specify the instance ID.

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

nas-identifier nas_identifier

Specify the attribute name by which the system will be identified in Auth or Accounting Request messages.

Must be a string in the fmtstr pattern. For information on the fmtstr pattern, see the Input Pattern Types chapter.

nas-ip aaa_nas_ipv4_address

Specify the AAA NAS IPv4 address.

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

-Or-

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

Usage Guidelines

Use this command to configure instance configuration parameters.

profile radius accounting detect-dead-server

Configures the response timeout duration, in seconds, to wait for a response from the RADIUS server after which it is marked as unreachable/dead.

Command Mode

Exec > Global Configuration (config) > RADIUS Configuration (config-radius)

Syntax

detect-dead-server response-timeout response_timeout 

response-timeout response_timeout

Specify the time interval, in seconds, for response from RADIUS server to mark as unreachable.

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

Usage Guidelines

Use this command to configure the response timeout duration, in seconds, to wait for a response from the RADIUS server after which it is marked as unreachable/dead.

profile radius allow auth

Configures the allow-auth on RADIUS server.

Command Mode

Exec > Global Configuration (config) > RADIUS Configuration (config-radius)

Syntax

enable-allow-auth 

enable-allow-auth

If allow-auth is enabled in the configuration, it allows the ongoing call to continue irrespective of authentication being successful, timed out, or any error message received. The default value is false, configuration is required to enable the allow-auth.

Usage Guidelines

Use this command to enble allow-auth in RADIUS server.

radius profile server group allow auth

Configures the allow-auth on RADIUS server group.

Command Mode

Exec > Global Configuration (config) > RADIUS Configuration (config-radius) > Server Group (config server group)

Syntax

enable-allow-auth 

enable-allow-auth

If allow-auth is enabled in the configuration, it allows the ongoing call to continue irrespective of authentication being successful, timed out, or any error message received. The default value is false, configuration is required to enable the allow-auth.

Usage Guidelines

Use this command to enble allow-auth on any of the RADIUS server group.

profile radius attribute

Configures RADIUS identification parameters.

Command Mode

Exec > Global Configuration (config) > RADIUS Configuration (config-radius)

Syntax

attribute { nas-identifier nas_id | nas-ip aaa_nas_ipv4_address } 

nas-identifier nas_identifier

Specify the attribute name by which the system will be identified in Auth or Accounting Request messages.

Must be a string in the fmtstr pattern. For information on the fmtstr pattern, see the Input Pattern Types chapter.

nas-identifier nas_identifier

Specify the attribute name by which the system will be identified in Auth or Accounting Request messages.

Must be a string in the fmtstr pattern. For information on the fmtstr pattern, see the Input Pattern Types chapter.

nas-ip aaa_nas_ipv4_address

Specify the AAA NAS IPv4 address.

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

-Or-

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

Usage Guidelines

Use this command to configure RADIUS identification parameters.

profile radius attribute instance

Configures instance configuration parameters.

Command Mode

Exec > Global Configuration > RADIUS Configuration (config-radius)

Syntax

attribute instance instance_id nas-ip aaa_nas_ipv4_address 

instance instance_id

Specify the instance ID.

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

nas-identifier nas_identifier

Specify the attribute name by which the system will be identified in Auth or Accounting Request messages.

Must be a string in the fmtstr pattern. For information on the fmtstr pattern, see the Input Pattern Types chapter.

instance instance_id

Specify the instance ID.

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

nas-identifier nas_identifier

Specify the attribute name by which the system will be identified in Auth or Accounting Request messages.

Must be a string in the fmtstr pattern. For information on the fmtstr pattern, see the Input Pattern Types chapter.

nas-ip aaa_nas_ipv4_address

Specify the AAA NAS IPv4 address.

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

-Or-

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

Usage Guidelines

Use this command to configure instance configuration parameters.

profile radius consecutive failure dead server detection

Configures the value of consecutive failreres in the RADIUS server, after the value is reached, the server is marked as unreachable/dead.

Command Mode

Exec > Global Configuration (config) > RADIUS Configuration (config-radius)

Syntax

detect-dead-server consecutive-failures value 

detect-dead-server consecutive-failures value

When a server's failure count reaches the threshold for consecutive failures, the server is declared as dead server.

value : must be an integer in the range of 1–1000. Default: 10.

It is recommended to configure the consecutive failure value more than the request maxTransmissions value in the setup.

Usage Guidelines

Use this command to configure the failure value before the server is marked as dead.

profile radius detect-dead-server

Configures the response timeout duration, in seconds, to wait for a response from the RADIUS server after which it is marked as unreachable/dead.

Command Mode

Exec > Global Configuration (config) > RADIUS Configuration (config-radius)

Syntax

detect-dead-server response-timeout response_timeout 

response-timeout response_timeout

Specify the time interval, in seconds, for response from RADIUS server to mark as unreachable.

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

Usage Guidelines

Use this command to configure the response timeout duration, in seconds, to wait for a response from the RADIUS server after which it is marked as unreachable/dead.

profile radius dictionary

Configures RADIUS dictionary.

Command Mode

Exec > Global Configuration (config) > RADIUS Configuration (config-radius)

Syntax

dictionary  dictionary_name 

dictionary dictionary_name

Specify the name of the dictionary as: Identify Services Engine (ISE) or 3GPP dictionary.

If this dictionary is configured, the SMF service renders the RADIUS configuration and populates the request messages with selected dictionary specific parameters.

Must be a string.

Usage Guidelines

Use this command to configure RADIUS dictionary.

profile radius max transmissions

Configures the max-transmissions in the RADIUS server.

Command Mode

Exec > Global Configuration (config) > RADIUS Configuration (config-radius)

Syntax

max-transmissions value 

max-transmissions value

Max transmission allows to configure the transmission parameters for all the available servers. This feature helps to cross-check if the number of transmissions exceeds the number of retries once the retry cycle for a request is finished, and if so, it begins the subsequent retry cycle on a different server if one is available. If no server is available or if maxtransimissions limit is reached, then the server database sends out the timeout response.

value : must be an integer in the range of 0–65535. Default: 6.

Usage Guidelines

Use this command to configure the value of max-transmissions in the RADIUS server.

profile radius server

Configures the external RADIUS server parameters.

Command Mode

Exec > Global Configuration (config) > RADIUS Configuration (config-radius) > RADIUS Server Group Configuration (config-server-group-group_name )

Syntax

server radius_server_ip_address radius_server_port_number [ [ secret radius_server_secret ] [ priority radius_server_priority ] [ type server_type ] ] 

priority radius_server_priority

Specify the priority of the RADIUS server.

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

secret radius_server_secret

Specify the RADIUS server secret.

Must be a string.

type server_type

Specify the server type.

Must be one of the following:

  • acct : Specify the server is used for Accounting requests.

  • auth : Specify the server is used for Authentication/Author requests.

Default Value: auth.

radius_server_ip_address

Specify the IP address of the RADIUS server.

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

-Or-

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

radius_server_port_number

Specify the port number of the RADIUS server.

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

Usage Guidelines

Use this command to configure the external RADIUS server parameters.

profile radius server-group

Configures association of RADIUS servers to groups.

Command Mode

Exec > Global Configuration (config) > RADIUS Configuration (config-radius)

Syntax

server-group server_group_name 

algorithm sever_selection_algorithm

Specify the algorithm for selecting the RADIUS server. Default Value: first-server.

Must be one of the following:

  • first-server

  • round-robin

server-group server_group_name

Specify name of the RADIUS server group.

Must be a string in the fmtstr pattern. For information on the fmtstr pattern, see the Input Pattern Types chapter.

max_retries

Specify the maximum number of times the system will attempt retry with the RADIUS server.

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

timeout_interval

Specify the time interval to elapse for a response from the RADIUS server before re-transmitting.

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

Usage Guidelines

Use this command to configure the association of RADIUS servers to groups.

profile radius server-group accounting

Configures RADIUS accounting parameters.

Command Mode

Exec > Global Configuration

Syntax

accounting options 

algorithm sever_selection_algorithm

Specify the algorithm for selecting the RADIUS server. Default Value: first-server.

Must be one of the following:

  • first-server

  • round-robin

max_retries

Specify the maximum number of times the system will attempt retry with the RADIUS server.

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

timeout_interval

Specify the time interval to elapse for a response from the RADIUS server before re-transmitting.

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

Usage Guidelines

Use this command to configure the RADIUS accounting parameters.

profile radius server-group accounting attribute

Configures RADIUS identification parameters.

Command Mode

Exec > Global Configuration (config) > RADIUS Configuration (config-radius)

Syntax

attribute { nas-identifier nas_id | nas-ip aaa_nas_ipv4_address } 

nas-identifier nas_identifier

Specify the attribute name by which the system will be identified in Auth or Accounting Request messages.

Must be a string in the fmtstr pattern. For information on the fmtstr pattern, see the Input Pattern Types chapter.

nas-identifier nas_identifier

Specify the attribute name by which the system will be identified in Auth or Accounting Request messages.

Must be a string in the fmtstr pattern. For information on the fmtstr pattern, see the Input Pattern Types chapter.

nas-ip aaa_nas_ipv4_address

Specify the AAA NAS IPv4 address.

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

-Or-

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

Usage Guidelines

Use this command to configure RADIUS identification parameters.

profile radius server-group accounting attribute instance

Configures instance configuration parameters.

Command Mode

Exec > Global Configuration > RADIUS Configuration (config-radius)

Syntax

attribute instance instance_id nas-ip aaa_nas_ipv4_address 

instance instance_id

Specify the instance ID.

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

nas-identifier nas_identifier

Specify the attribute name by which the system will be identified in Auth or Accounting Request messages.

Must be a string in the fmtstr pattern. For information on the fmtstr pattern, see the Input Pattern Types chapter.

instance instance_id

Specify the instance ID.

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

nas-identifier nas_identifier

Specify the attribute name by which the system will be identified in Auth or Accounting Request messages.

Must be a string in the fmtstr pattern. For information on the fmtstr pattern, see the Input Pattern Types chapter.

nas-ip aaa_nas_ipv4_address

Specify the AAA NAS IPv4 address.

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

-Or-

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

Usage Guidelines

Use this command to configure instance configuration parameters.

profile radius server-group attribute

Configures RADIUS identification parameters.

Command Mode

Exec > Global Configuration (config) > RADIUS Configuration (config-radius)

Syntax

attribute { nas-identifier nas_id | nas-ip aaa_nas_ipv4_address } 

nas-identifier nas_identifier

Specify the attribute name by which the system will be identified in Auth or Accounting Request messages.

Must be a string in the fmtstr pattern. For information on the fmtstr pattern, see the Input Pattern Types chapter.

nas-identifier nas_identifier

Specify the attribute name by which the system will be identified in Auth or Accounting Request messages.

Must be a string in the fmtstr pattern. For information on the fmtstr pattern, see the Input Pattern Types chapter.

nas-ip aaa_nas_ipv4_address

Specify the AAA NAS IPv4 address.

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

-Or-

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

Usage Guidelines

Use this command to configure RADIUS identification parameters.

profile radius server-group attribute instance

Configures instance configuration parameters.

Command Mode

Exec > Global Configuration > RADIUS Configuration (config-radius)

Syntax

attribute instance instance_id nas-ip aaa_nas_ipv4_address 

instance instance_id

Specify the instance ID.

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

nas-identifier nas_identifier

Specify the attribute name by which the system will be identified in Auth or Accounting Request messages.

Must be a string in the fmtstr pattern. For information on the fmtstr pattern, see the Input Pattern Types chapter.

instance instance_id

Specify the instance ID.

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

nas-identifier nas_identifier

Specify the attribute name by which the system will be identified in Auth or Accounting Request messages.

Must be a string in the fmtstr pattern. For information on the fmtstr pattern, see the Input Pattern Types chapter.

nas-ip aaa_nas_ipv4_address

Specify the AAA NAS IPv4 address.

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

-Or-

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

Usage Guidelines

Use this command to configure instance configuration parameters.

profile radius server-group server

Configures the RADIUS server parameters.

Command Mode

Exec > Global Configuration (config) > RADIUS Configuration (config-radius) > RADIUS Server Group Configuration (config-server-group-group_name )

Syntax

server type server_type radius_server_ip_address radius_server_port_number 

type server_type

Specify the RADIUS server type.

Must be one of the following:

  • acct : Specify the server is used for Accounting requests.

  • auth : Specify the server is used for Authentication/Author requests.

radius_server_ip_address

Specify the IP address of the RADIUS server.

radius_server_port_number

Specify the port number of the RADIUS server.

Usage Guidelines

Use this command to configure the RADIUS server parameters.

profile radius server group max transmissions

Configures the max-transmissions on the RADIUS server group.

Command Mode

Exec > Global Configuration (config) > RADIUS Configuration (config-radius) > Server Group (config server-group)

Syntax

max-transmissions value 

max-transmissions value

Max transmission allows to configure the transmission parameters for all the available server groups. This feature helps to cross-check if the number of transmissions exceeds the number of retries once the retry cycle for a request is finished, and if so, it begins the subsequent retry cycle on a different server group if one is available. If no server group is available or if maxtransimissions limit is reached, then the server database sends out the timeout response.

value : must be an integer in the range of 0–65535. Default: 6.

Usage Guidelines

Use this command to configure the value of max-transmissions on the RADIUS server group.

profile radius-dynamic-author

Configures the RADIUS Dynamic Author/COA profile.

Command Mode

Exec > Global Configuration (config)

Syntax

profile radius-dynamic-author [ client client_ip_address | secret secret_key | nas-identifier nas_identifier ] 

nas-identifier nas_id

Specify the Dynamic Author NAS ID.

Must be a string in the fmtstr pattern. For information on the fmtstr pattern, see the Input Pattern Types chapter.

nas-identifier nas_id

Specify the Dynamic Author NAS ID.

Must be a string in the fmtstr pattern. For information on the fmtstr pattern, see the Input Pattern Types chapter.

secret secret_key

Specify the Dynamic Author server shared secret key.

Must be a string.

Usage Guidelines

Use this command to configure the RADIUS Dynamic Author/COA profile.

profile radius-dynamic-author client

Configures the RADIUS Dynamic Author Client parameters.

Command Mode

Exec > Global Configuration

Syntax

client ip radius_client_ip_address secret secret_key 

ip radius_client_ip_address

Specify the IP address of the RADIUS client.

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

-Or-

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

secret secret_key

Specify the client shared secret key.

Must be a string.

Usage Guidelines

Use this command to configure the RADIUS Dynamic Author Client parameters.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

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 smf

Configures SMF profile.

Command Mode

Exec > Global Configuration (config)

Syntax

smf profile_name [ [ dnn-selection-mode dnn_selection_mode ] [ load-profile load_profile_name ] [ locality locality ] [ mode mode_of_operation ] [ nf-services nf_services ] [ overload-profile overload_profile_name ] [ ue-authorization ue_authorization ] ] 

dnn-selection-mode dnn_selection_mode

NOTE: This command/keyword is deprecated from SMF Profile and has been added under DNN Profile. Specify the selection mode for subscription.

Must be one of the following:

  • network-provided

  • ue-provided

  • verified

load-profile load_profile_name

Specify the name of the load profile.

Must be a string.

locality locality

Specify the locality for geo support.

Must be a string.

mode mode_of_operation

Specify the mode of operation.

Must be one of the following:

  • offline : Offline mode. New sessions will be rejected.

nf-services nf_services

Specify the NF services.

Must be a string.

overload-profile overload_profile_name

Specify the name of the overload profile. Note that the load-profile configuration is mandatory to configure the overload-profile configuration.

Must be a string.

smf profile_name

Specify name of the SMF profile.

Must be a string.

ue-authorization ue_authorization

The SMF supports PDU sessions with IPv4v6 type in addition to IPv4 and IPv6 PDU session types for UEs. When a UE requests establishment of PDU session with a specific session type, the SMF checks the UE request against the UE subscription information maintained as default and allowed listPDU session types in the UDM. The SMF performs UE authorization and allocates IP address when the requested PDN type is matching with the values in the UDM. The SMF communicates about the allocated IP address to all other network functions.

Must be one of the following:

  • none

Usage Guidelines

Use this command to configure the SMF network function profile parameters.

profile smf instances

Configures the Geographic Redundancy (GR) instance ID.

Command Mode

Exec > Global Configuration (config) > SMF Profile Configuration (config-smf-profile_name )

Syntax

instances gr_instance_id [ [ allowed-nssai allowed_nssai ] [ fqdn fqdn ] [ inter-plmn-fqdn inter_plmn_fqdn [ node-id node_id] [ supported-features supported_features ] ] 

allowed-nssai nssai

Specify the Network Slice Selection Assistance Information (NSSAI).

Must be a string.

fqdn fqdn

Specify the SMF+PGW-C FQDN.

Must be a string.

inter-plmn-fqdn inter_plmn_fqdn

Specify the inter-PLMN-FQDN, which is used in home and visiting SMF communication via SEPP.

Must be a string.

node-id node_id

Specify the SMF's node ID. For example, 1A2B3c.

Must be a string in the hex-string6 pattern. For information on the hex-string6 pattern, see the Input Pattern Types chapter.

supported-features supported_features

Specify the supported features.

Must be one of the following:

  • vsmf

gr_instance_id

Specify the GR instance ID.

Usage Guidelines

Use this command to configure the GR instance ID.

profile smf plmn-id

Configures the definition for public land mobile network identifier (PLMN ID) and the preferred radio access technology (RAT). This is one of PLMNs which is considered by the mobile as equivalent to the visited PLMN for cell reselection and network selection. When configured, the equivalent PLMN list will be sent to the UE in NAS ATTACH ACCEPT / TAU ACCEPT messages.

Command Mode

Exec > Global Configuration (config) > SMF Profile Configuration (config-smf-profile_name )

Syntax

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

mcc mobile_country_code

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

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

mnc mobile_network_code

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

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

Usage Guidelines

Use the command to identify a PLMN and assign it a priority to define the preferred PLMN to be used. This command can be entered multiple times to set priorities of usage.

profile smf plmn-list

Configures the SMF proflie PLMN list parameters.

Command Mode

Exec > Global Configuration (config) > SMF Profile Configuration (config-smf-profile_name )

Syntax

plmn-list mcc mobile_country_code mnc mobile_network_code 

mcc mobile_country_code

Specify the 3-digit Mobile Country Code.

mnc mobile_network_code

Specify the 2- or 3-digit Mobile Country Network.

Usage Guidelines

Use this command to configure the SMF proflie PLMN list parameters. If configured, both PLMN ID and PLMN list are used.

You can configure a maximum of 32 elements with this command.

profile smf service

Configures the session management network function services.

Command Mode

Exec > Global Configuration (config) > SMF Profile Configuration (config-smf-profile_name )

Syntax

service name service_name [ access-profile profile_name | capacity capacity | compliance-profile compliance_profile_name | icmpv6-profile profile_name | nf-service nf_service_name | priority priority | schema schema_name | service-id service_id | subscriber-policy policy_name | type service_type | version version ] 

access-profile profile_name

Specify name of the access profile.

Must be a string.

capacity capacity

Specify the static weight relative to other NFs of the same type.

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

Default Value: 10.

compliance-profile compliance_profile_name

Specify name of the compliance profile.

Must be a string.

icmpv6-profile profile_name

Specify name of the ICMPv6 profile.

Must be a string.

name nf_service_name

Specify name of the NF service.

Must be a string.

priority priority

Specify the priority relative to other NFs of the same type.

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

Default Value: 1.

schema schema_name

Specify name of the schema.

Must be a string.

service-id service_id

Specify the service ID.

Must be a string.

Default Value: 1.

subscriber-policy policy_name

Specify name of the subscriber policy.

Must be a string.

type service_type

Specify the service type.

Must be one of the following:

  • pdu-session

  • sm-event-exposure

version version

Specify the version.

Must be a string.

Usage Guidelines

Use this command to configure the N1, N2, and N11 interfaces in compliance with the 3GPP. The service names are specified in 3GPPTS 29.510 V15.2.0, Section 6.1.6.3.11. The CLI prompt changes to the Service Configuration mode (config-service-<service_name>).

profile smf service http-endpoint

Configures the SMF HTTP REST endpoint parameters.

Command Mode

Exec > Global Configuration (config) > SMF Profile Configuration (config-smf-profile_name ) > Service Configuration (config-service-service_name )

Syntax

http-endpoint base-url base_url 

base-url base_url

Specify the SMF base URL that is exposed and accessible externally.

Must be a string.

Usage Guidelines

Use this command to configure the SMF HTTP REST endpoint parameters.

profile tai-group

Configures TAI group profile parameters.

Command Mode

Exec > Global Configuration (config)

Syntax

profile tai-group tai_group_name [ priority tai_group_priority ] 

priority tai_group_priority

Specify the priority of this TAI group.

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

tai-group tai_group_name

Specify name of the TAI group.

Must be a string.

Usage Guidelines

Use this command to configure the TAI group profile parameters.

profile tai-group tais

Configures the list of MCC and MNC.

Command Mode

Exec > Global Configuration (config) > TAI Group Profile Configuration (config-tai-group-profile_name )

Syntax

tais { mcc mobile_country_code | mnc mobile_network_code } 

mcc mobile_country_code

Specify the Mobile Country Code (MCC).

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

mnc mobile_network_code

Specify the Mobile Network Code (MNC).

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

Usage Guidelines

Use this command to configure the list of MCC and MNC.

You can configure a maximum of 16 elements with this command.

profile tai-group tais tac

Configures the TAC Group parameters.

Command Mode

Exec > Global Configuration (config) > TAI Group Profile Configuration (config-tai-group-profile_name )

Syntax

tac tac_values 

tac tac_values

Specify the list of TAC values.

Must be a string in the hex-stringtac pattern. For information on the hex-stringtac pattern, see the Input Pattern Types chapter.

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

Usage Guidelines

Use this command to configure the TAC Group parameters.

profile tai-group tais tac range

Configures TAC ranges.

Command Mode

Exec > Global Configuration (config) > TAI Group Profile Configuration (config-tai-group-profile_name )

Syntax

range start tac_range_start end tac_range_end 

end tac_range_end

Specify the TAC range end value.

Must be a string in the hex-stringtac pattern. For information on the hex-stringtac pattern, see the Input Pattern Types chapter.

start tac_range_start

Specify the TAC range start value.

Must be a string in the hex-stringtac pattern. For information on the hex-stringtac pattern, see the Input Pattern Types chapter.

Usage Guidelines

Use this command to configure a TAC range.

You can configure a maximum of 64 elements with this command.

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 | supported-features supported_features ] 

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.

supported-features supported_features

Specify the list of features supported by the UPF node.

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

profile wps wps_service_name [ arp arp_level_range [ qci ] message-priority-profile  profile_name    ] ] 
      profile message-prioritymsg_priority_profile_name  
      interface [ any | pfcp | sbi [ { create | update | delete } ] ] 
         priority value range 

arp arp_level_range

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

Specify the ARP value in integer from 1 to 15.

-Or-

Must be a string.

qci message-priority-profile profile_name : Wireless Priority session is decided based on the ARP and optionally on the QCI.

message-priority-profile profile_name : This parameter is used only if the message priority profile is not associated. For example, message-priority-profile [ pfcp gtpc ].


Important


If you are upgrading SMF from Release 2023.03.0 to a later release, make sure you manually reconfigure the ARP parameter in the WPS profile after the upgrade is complete.


wps wps_service_name

Specify name of the WPS service.

Must be a string.

interface [ any | pfcp | sbi [ { create | update | delete } ] ]

  • interface [ any | pfcp | sbi ] : Specify priority value per interface and in case of SBI interface, configure based on a procedure. If procedure is not configured, same value is applied for all procedures. Interface type is optional and if not configured, same value is applied across all interfaces.

  • priority value : Specifies the range of priority levels from 0 to 31 for sbi or 0 to 15 for pfcp, gtp, or any, where 0 indicates the highest priority, while 31 or 15 indicates the lowest priority.


    Note


    Priority is not populated in outbound messages, which are self-triggered. For example, outbound messages triggered by timer expiry.

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 values.

Command Mode

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

Syntax

dscp { [ n3 up_dscp_marking ] [ n4 cp_dscp_marking ] [ s2b dscp_marking ] [ s5 dscp_marking ] [ s5e cp_dscp_marking ] [ s8 dscp_marking ] [ s11 cp_dscp_marking ] [ sxa cp_dscp_marking ] ] 

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.

n3 up_dscp_marking

Specify the N3 UP DSCP marking value.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

n4 cp_dscp_marking

Specify the N4 CP DSCP marking value.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

s11 cp_dscp_marking

Specify the S11 CP DSCP marking value.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

s2b dscp_marking

Specify the S2B DSCP marking value.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

s5 dscp_marking

Specify the S5 DSCP marking value.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

s5e cp_dscp_marking

Specify the S5E CP DSCP marking value.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

s8 dscp_marking

Specify the S8 DSCP marking value.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

sxa cp_dscp_marking

Specify the SXA CP DSCP marking value.

Must be a string in the hex-stringdscp pattern. For information on the hex-stringdscp pattern, see the Input Pattern Types chapter.

Usage Guidelines

Use this command to configure the DSCP marking values.

service name type

Configures UDM services.

Command Mode

Exec > UDM message handling profile configuration.

Syntax

service name type { nudm-ee | nudm-pp | nudm-sdm | nudm-ueau | nudm-uecm } service_type 

service name type { nudm-ee | nudm-pp | nudm-sdm | nudm-ueau | nudm-uecm } service_type

Configure the UDM services based on the use case scenario.

SMF allows configuration of these different UDM service types:

  • nudm-ee —Specify this service for NEFs to subscribe to or unsubscribe from UDM event notifications.

  • nudm-pp —Specify this service to provision information, which can be used for the UE in 5GS.

  • nudm-sdm — Specify this service to retrieve UE subscription data relevant to their operation from the UDM. The nudm-sdm service type enables the UDM local configuration.

  • nudm-ueau —Specify this service to inform the UDM of authentication results, to query authentication results, and to purge authentication results.


    Note


    The Nudm_UEAuthentication service is used by SMF to obtain UE authentication vectors from the UDM.
  • nudm-uecm —Specify this service to allow the SMF to register and deregister itself as serving the UE, and to update the UE context information in the UDM.

Usage Guidelines

Use this command to configure different types of UDM services.

radius

Displays RADIUS Client information.

Command Mode

Exec

Syntax

show radius 

Usage Guidelines

Use this command to view RADIUS Client information.

radius acct-server

Displays RADIUS Accounting Server information.

Command Mode

Exec

Syntax

show radius acct-server 

Usage Guidelines

Use this command to view RADIUS Accounting Server information.

radius auth-server

Displays RADIUS Authentication Server information.

Command Mode

Exec

Syntax

show radius auth-server 

Usage Guidelines

Use this command to view RADIUS Authentication Server information.

radius-dyn-auth

Displays RADIUS Dynamic Author data.

Command Mode

Exec

Syntax

show radius-dyn-auth 

Usage Guidelines

Use this command to view the RADIUS Dynamic Author data.

radius-dyn-auth clients

Displays RADIUS Authentication Server information.

Command Mode

Exec

Syntax

show radius auth-server 

Usage Guidelines

Use this command to view RADIUS RADIUS Authentication Server information.

rcm switchover

Configures Redundancy and Configuration Manager (RCM) switchover operation.

Privilege Level

Security Administrator, Administrator

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.

reconcile ipam

Reconciles IPAM data with CDL records.

Command Mode

Exec > Global Configuration (config)

Syntax

reconcile ipam 

Usage Guidelines

Use this command to reconcile IPAM data with CDL records.

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.

screen-length

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

Privilege Level

Security Administrator, Administrator

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.

Privilege Level

Security Administrator, Administrator

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.

Privilege Level

Security Administrator, Administrator

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.

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.

quit

Exits the management session.

Privilege Level

Security Administrator, Administrator

Command Mode

Exec

Syntax

quit 

Usage Guidelines

Use this command to exit the management session.

show

Displays the system information.

Privilege Level

Security Administrator, Administrator

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 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 ] } 

access access_technology

Specify the access technology.

Must be a string of 11-25 characters.

all

Specify all SUPIs or IMEIs.

amf amf_address

Specify the AMF address.

Must be a string of 7-39 characters.

apn apn_name

Specify name of the APN.

Must be a string of 1-255 characters.

auth-status radius_auth_status

Specify the RADIUS authentication status - authenticated or unauthenticated.

Must be a string of 13, or 15 characters.

chf chf_address

Specify the CHF address.

Must be a string of 7-39 characters.

connectivity connectivity_type

Specify the connectivity type.

Must be a string of 2 characters.

count count

Specify the count.

Must be one of the following:

  • count

debug-info debug_info

Specify print the debug info.

Must be one of the following:

  • debug-info

dnn dnn_value

Specify the DNN value.

Must be a string of 1-255 characters.

emergency { false | true }

Specify emergency session indication.

Must be one of the following:

  • false

  • true

gpsi gpsi

Specify the Generic Public Subscription Identifier (GPSI).

Must be a string of 1-255 characters.

gr-instance gr_instance

Specify the network function service under which to search.

gtp-peer gtp_peer_address

Specify address of the GTP peer.

Must be a string of 7-39 characters.

imei imei_id

Specify the International Mobile Equipment Identity.

Must be a string of 15-16 characters.

imsi imsi

Specify the International Mobile Subscriber Identifier (IMSI).

Must be a string.

ipv4-addr ipv4_address

Specify the IPv4 address in the format pool_name /ipv4_address .

Must be a string of 1-255 characters.

ipv4-pool ipv4_pool_name

Specify name of the IPv4 pool.

Must be a string of 1-255 characters.

ipv4-range ipv4_address_range

Specify the IPv4 address range in the format pool_name /start_ip_address .

Must be a string of 1-255 characters.

ipv6-pfx ipv6_pfx

Specify the IPv6 prefix in the format pool_name /ipv6_prefix .

Must be a string of 1-255 characters.

ipv6-pool ipv6_pool_name

Specify name of the IPv6 pool.

Must be a string of 1-255 characters.

ipv6-range ipv6_prefix_range

Specify the IPv6 prefix range in the format pool_name /start_prefix .

Must be a string of 1-255 characters.

msid msid

Specify the Mobile Subscriber Identification Number (MSID).

Must be a string of 1-255 characters.

msisdn msisdn

Specify the Mobile Station International Subscriber Directory Number (MSISDN).

Must be a string of 1-255 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.

pcf pcf_address

Specify the PCF address.

Must be a string of 7-39 characters.

peerGtpuEpKey gtpu_peer_address

Specify address of the GTPU peer in the upf_addr:gptu_peer_addr format.

Must be a string of 1-255 characters.

pei permanent_equipment_id

Specify the Permanent Equipment Identifier.

Must be a string of 1-255 characters.

policy policy_type

Specify the subscriber policy type information.

Must be one of the following:

  • local

  • pcf

rat rat_type

Specify the RAT type.

Must be a string of 2, 4, or 7 characters.

roaming-status ue_roaming_status

Specify the UE roaming status.

Must be a string of 5, 6, 10, or 11 characters.

smf smf_address

Specify address of the SMF.

Must be a string of 7-39 characters.

supi supi_id

Specify the subscriber's SUPI ID.

Must be a string.

udm-sdm udm_sdm_address

Specify the UDM-SDM address.

Must be a string of 7-39 characters.

udm-sdm udm_uecm_address

Specify the UDM-UECM address.

Must be a string of 7-39 characters.

ue-type ue_type

Specify device capability - 4G-only / NR-capable.

Must be a string of 7, or 10 characters.

upf upf_address

Specify the UPF address.

Must be a string of 7-39 characters.

Usage Guidelines

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

show subscriber count-opt

Displays subscriber session count information.

Command Mode

Exec

Syntax

show subscriber count { all | access access_technology | amf amf_address | apn apn_name | auth-status radius_auth_status | chf chf_address | connectivity connectivity_type | dnn dnn_value | emergency { false | true } | gpsi gpsi | gtp-peer gtp_peer_address | ipv4-addr ipv4_address | ipv4-pool ipv4_pool_name | ipv4-range ipv4_address_range | ipv6-pfx ipv6_prefix | ipv6-pool ipv6_pool_name | ipv6-range ipv6_prefix_range | msid msid | msisdn msisdn | pcf pcf_address | peerGtpuEpKey gtpu_peer_address | pei permanent_equipment_id | policy policy_type | psid pdu_session_id | rat rat_type | roaming-status ue_roaming_status | supi supi | udm-sdm udm_sdm_address | udm-uecm udm_uecm_address | upf upf_address } 

access access_technology

Specify the access technology.

Must be a string of 11-25 characters.

all

Specify all SUPIs.

amf amf_address

Specify the AMF address.

Must be a string of 7-39 characters.

apn apn_name

Specify name of the APN.

Must be a string of 1-255 characters.

auth-status radius_auth_status

Specify the RADIUS authentication status - authenticated or unauthenticated.

Must be a string of 13, or 15 characters.

chf chf_address

Specify the CHF address.

Must be a string of 7-39 characters.

connectivity connectivity_type

Specify the connectivity type.

Must be a string of 2 characters.

dnn dnn_value

Specify the DNN value.

Must be a string of 1-255 characters.

emergency { false | true }

Specify emergency session indication.

Must be one of the following:

  • false

  • true

gpsi gpsi

Specify the Generic Public Subscription Identifier (GPSI).

Must be a string.

gtp-peer gtp_peer_address

Specify address of the GTP peer.

Must be a string of 7-39 characters.

ipv4-addr ipv4_address

Specify the IPv4 address in the format pool_name /ipv4_address .

Must be a string of 1-255 characters.

ipv4-pool ipv4_pool_name

Specify name of the IPv4 pool.

Must be a string of 1-255 characters.

ipv4-range ipv4_address_range

Specify the IPv4 address range in the format pool_name /start_ip_address .

Must be a string of 1-255 characters.

ipv6-pfx ipv6_pfx

Specify the IPv6 prefix in the format pool_name /ipv6_prefix .

Must be a string of 1-255 characters.

ipv6-pool ipv6_pool_name

Specify name of the IPv6 pool.

Must be a string of 1-255 characters.

ipv6-range ipv6_prefix_range

Specify the IPv6 prefix range in the format pool_name /start_prefix .

Must be a string of 1-255 characters.

msid msid

Specify the Mobile Station Identifier (MSID).

Must be a string.

msisdn msisdn

Specify the Mobile Station International Subscriber Directory Number (MSISDN).

Must be a string.

pcf pcf_address

Specify the PCF address.

Must be a string of 7-39 characters.

peerGtpuEpKey gtpu_peer_address

Specify address of the GTPU peer in the upf_addr:gptu_peer_addr format.

Must be a string of 1-255 characters.

pei permanent_equipment_id

Specify the Permanent Equipment Identifier.

Must be a string of 1-255 characters.

policy policy_type

Specify the subscriber policy type information.

Must be one of the following:

  • local

  • pcf

psid pdu_session_id

Specify the PDU Session Identifier.

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

rat rat_type

Specify the RAT type.

Must be a string of 2, 4, or 7 characters.

roaming-status ue_roaming_status

Specify the UE roaming status.

Must be a string of 5, 6, 10, or 11 characters.

smf smf_address

Specify address of the SMF.

Must be a string of 7-39 characters.

supi supi

Specify the Subscription Permanent Identifier (SUPI), the value must include the IMSI prefix.

Must be a string.

udm-sdm udm_sdm_address

Specify the UDM-SDM address.

Must be a string of 7-39 characters.

udm-sdm udm_uecm_address

Specify the UDM-UECM address.

Must be a string of 7-39 characters.

ue-type ue_type

Specify device capability - 4G-only / NR-capable.

Must be a string of 7, or 10 characters.

upf upf_address

Specify the UPF address.

Must be a string of 7-39 characters.

Usage Guidelines

Use this command to view subscriber session count information.

show subscriber debug-opt

Configures debug option.

Command Mode

Exec

Syntax

debug-opt { supi supi | msid msid | pei pei_imei | gpsi gpsi | msisdn msisdn | imsi imsi } 

gpsi gpsi

Specify the GPSI.

Must be a string.

imsi imsi

Specify the International Mobile Subscriber Identifier (IMSI).

Must be a string.

msid msid

Specify the Mobile Station Identifier (MSID).

Must be a string.

msisdn msisdn

Specify the Mobile Station International Subscriber Directory Number (MSISDN).

Must be a string.

pei pei_imei

Specify the Permanent Equipment Identifier (PEI)/International Mobile Equipment Identifier (IMEI).

Must be a string.

psid psid

Specify the PDU Session ID.

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

supi supi

Specify the Subscription Permanent Identifier (SUPI), the value must include the IMSI prefix.

Must be a string.

Usage Guidelines

Use this command to configure debug option.

show subscriber gpsi-opt policy-opt

Displays policy option.

Command Mode

Exec

Syntax

show subscriber supi supi_id policy policy_option 

policy policy_option

Specify the policy option.

Must be one of the following:

  • flow

  • rules

Usage Guidelines

Use this command to view policy option.

show subscriber imsi-opt

Displays subscriber data based on IMSI.

Command Mode

Exec

Syntax

show subscriber imsi-options imsi_option 

imsi-options imsi_option

Specify the IMSI option.

Must be one of the following:

  • full

Usage Guidelines

Use this command to view subscriber data based on IMSI.

show subscriber msid-opt policy-opt

Displays policy option.

Command Mode

Exec

Syntax

show subscriber supi supi_id policy policy_option 

policy policy_option

Specify the policy option.

Must be one of the following:

  • flow

  • rules

Usage Guidelines

Use this command to view policy option.

show subscriber msisdn-opt policy-opt

Displays policy option.

Command Mode

Exec

Syntax

show subscriber supi supi_id policy policy_option 

policy policy_option

Specify the policy option.

Must be one of the following:

  • flow

  • rules

Usage Guidelines

Use this command to view policy option.

show subscriber pei-opt policy-opt

Displays policy option.

Command Mode

Exec

Syntax

show subscriber supi supi_id policy policy_option 

policy policy_option

Specify the policy option.

Must be one of the following:

  • flow

  • rules

Usage Guidelines

Use this command to view policy option.

show subscriber supi-opt

Displays subscriber data.

Command Mode

Exec

Syntax

show subscriber supi [ detail_option | psid pdu_session_id ] 

psid pdu_session_id

Specify the PDU Session ID.

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

detail_option

Specify the detail option.

Must be one of the following:

  • charging

  • full

  • policy

  • summary

  • userplane

Usage Guidelines

Use this command to view subscriber data.

show subscriber supi-opt policy-opt

Displays policy option.

Command Mode

Exec

Syntax

show subscriber supi supi_id policy policy_option 

policy policy_option

Specify the policy option.

Must be one of the following:

  • flow

  • rules

Usage Guidelines

Use this command to view policy option.

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.

show-defaults

Displays the default configuration.

Privilege Level

Security Administrator, Administrator

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.

Privilege Level

Security Administrator, Administrator

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.

Privilege Level

Security Administrator, Administrator

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.

system-diagnostics event-trace

Configures Event Trace configuration.

Syntax

system-diagnostics event-trace event_trace_state 

event-trace event_trace_state

Specify to enable or disable Event Trace configuration.

Must be one of the following:

  • disable

  • enable

Usage Guidelines

Use this command to enable or disable Event Trace configuration.

system-diagnostics idmgr-secondary-recon

Configures to trigger secondary reconciliation in NodeMgr using unique key.

Command Mode

Exec > Global Configuration (config)

Syntax

system-diagnostics idmgr-secondary-recon { false | true } 

idmgr-secondary-recon { false | true }

Triggers secondary reconciliation in NodeMgr using unique key.

Usage Guidelines

Use this command to enable or disable secondary reconciliation in NodeMgr using unique key.

system-diagnostics ip-validation

Configures IP address validation with CDL.

Syntax

ip-validation { enable | ignore-mismatch-responses } 

enable

Specify to enable new IP address validation with CDL.

ignore-mismatch-responses

Specify to ignore CDL inconsistencies during address validation.

Usage Guidelines

Use this command to configure IP address validation with CDL.

system-diagnostics pod type

Configures and enables your required pod from a cluster of the supported pods.

Command Mode

Exec > Global Configuration (config)

Syntax

system-diagnostics pod_type 

pod_type

Specify the required type of service pods for system diagnostics.

Must be one of the following:

  • diameter

  • gtp

  • pfcp

  • service

  • sgw-service

Usage Guidelines

Use this command to enable and configure your required pod from a cluster of the supported pods.

system-diagnostics pod type fault

Enables system fault panic recovery while session processing.

Command Mode

Exec > Global Configuration (config) > System Diagnostics Configuration (config-system-diagnostics-pod_type )

Syntax

fault { action action_on_fault | file-detail file_names_line_numbers | interval interval_duration | num max_fault_tolerance } 

action action_on_fault

Specify the action to take on fault occurence.

Must be one of the following:

  • abort

  • cleanup

  • graceful-Reload

  • reload

file-detail file_names_line_numbers

Specify the list of file names with line number to exclude from recovery. For example, procedures/pduim/procedure.go:1902.

Must be a string.

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

interval interval_duration

Specify the duration of the interval in minutes.

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

num max_fault_tolerance

Specify the maximum number of times fault can be tolerated in an interval.

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

Usage Guidelines

Use this command to enable and configure system fault panic recovery while session processing.

system-diagnostics protocol supi

Configures the list of SUPI values for which config has to be applied.

Syntax

supi subscription_permanent_id 

subscription_permanent_id

Specify the Subscription Permanent Identifier (SUPI).

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

Usage Guidelines

Use this command to configure the list of SUPI values for which config has to be applied.

system-diagnostics protocol supi preferred-up

Configures the preferred user plane node ID.

Syntax

preferred-up node-id node_id 

node-id node_id

Specify node ID of the preferred user plane node.

Must be a string.

Usage Guidelines

Use this command to configure the preferred user plane node ID.

system-diagnostics session-consistency

Enables and configures inconsistency checks on session data.

Syntax

system-diagnostics session-consistency action action_on_inconsistent_data 

action action_on_inconsistent_data

Specify the action to take on inconsistent data.

Must be one of the following:

  • cleanup

  • disabled

  • monitor

Usage Guidelines

Use this command to enable and configure inconsistency checks on session data.

terminal

Configures the type of terminal.

Privilege Level

Security Administrator, Administrator

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.

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.

test gtpc echo

Tests the connectivity of GTP-C peer nodes.

Command Mode

Exec

Syntax

test gtpc echo instance-id instance_id interface interface_type peer-address ip_address 

instance-id instance_id

Specifies the instance ID of a GR instance that is configured on the system.

interface interface_type

Specifies the type of GTP-C interface, such as S11, S5e, S5, S2b, or S8.

peer-address ip_address

Specifies IPv4 or IPv6 address of a specific peer to which GTP-C echo request is sent.

Usage Guidelines

Use this command to test connectivity of GTP-C peer nodes.

test gtpp echo

Tests the connectivity of a CGF server that is not configured in a GTPP profile.

Command Mode

Exec

Syntax

test gtpp echo instance-id instance_id ca-address ip_address [ ca-port port ] [ cgf-address ip_address ] [ cgf-port port ] 

instance-id instance_id

Specifies the instance ID of a GR instance that is configured on the system.

ca-address ip_address

Specifies the IPv4 address of charging agent configured within GTPP profile.

ca-port port

Specifies the port of charging agent configured within GTPP profile, ranging 1–65535. By default, the port is 49999.

cgf-address ip_address

Specifies the IPv4 address of a specific CGF server to which GTPP echo request is sent.

cgf-port port

Specifies the port of CGF server, ranging from 1– 65535. By default, the port is 3386.

Usage Guidelines

Use this command to check the connectivity of CGF server.

test-radius accounting

Tests RADIUS accounting server function.

Command Mode

Exec

Syntax

test-radius accounting { all [ [ client-nas ip_address ] [ username user_name ] ] | server server_ip_address [ [ client-nas ip_address ] [ port port_number ] [ username user_name ] ] | server-group [ [ client-nas ip_address ] [ username user_name ] ] } 

all

Specify to test all configured servers.

Must be one of the following:

  • all

client-nas ip_address

Specify IP address of the client NAS.

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

-Or-

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

port server_port_number

Specify the port number of the RADIUS server.

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

server-group server_group_name

Specify name of the server group.

Must be a string of 1-64 characters.

server server_ip_address

Specify the IP address of the RADIUS server.

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

-Or-

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

username user_name

Specify the user name.

Must be a string of 1-64 characters.

Default Value: test.

Usage Guidelines

Use this command to test RADIUS accounting server function.

test-radius authentication

Tests RADIUS authentication server function.

Command Mode

Exec

Syntax

test-radius authentication { all [ [ client-nas ip_address ] [ password password ] [ username user_name ] ] | server server_ip_address [ [ client-nas ip_address ] [ password password ] [ port port_number ] [ username user_name ] ] | server-group [ [ client-nas ip_address ] [ password password ] [ username user_name ] ] } 

all

Specify to test all configured servers.

Must be one of the following:

  • all

client-nas ip_address

Specify IP address of the client NAS.

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

-Or-

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

password password

Specify the password for user with authentication verified.

Must be a string of 1-64 characters.

Default Value: test.

port server_port_number

Specify the port number of the RADIUS server.

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

server-group server_group_name

Specify name of the server group.

Must be a string of 1-64 characters.

server server_ip_address

Specify the IP address of the RADIUS server.

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

-Or-

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

username user_name

Specify the user name.

Must be a string of 1-64 characters.

Default Value: test.

Usage Guidelines

Use this command to test RADIUS authentication server function.

timestamp

Configures the timestamp parameters.

Privilege Level

Security Administrator, Administrator

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.

Privilege Level

Security Administrator, Administrator

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.