Configures AAA-based user management parameters.

users list_of_local_users

Specify the user name.

Must be a string.

old-password user_password

Specify the user's current password.

Must be a string.

new-password user_password

Specify the user's new password.

Must be a string.

confirm-password user_password

Reenter the user's new password.

Must be a string.

Configures the change directory command.

directory

Specify the directory path.

Must be an alphanumeric string.

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

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.

Configures the CDL parameters to display the session details.

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.

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

db-name db_name

Specifies the database name for displaying the corresponding status.

Must be a string of 1 to 16 characters.

Clears l2tp tunnel.

force

Specify to force tunnel deletion, even if UP is down.

tunnel-id tunnel_id

Specify the tunnel ID.

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

tunnel-type tunnel_type

Specify the tunnel type.

Must be one of the following:

• lac

• lns

upf upf_name

Specify name of the User Plane Function.

Must be a string of 1-64 characters.

Clears BNG subscriber data.

force

Specify to force session deletion, even if UP is down.

ipv4-pool ipv4_pool_name

Specify name of the IPv4 address pool.

Must be a string of 1-64 characters.

ipv4-range ipv4_address_range

Specify the IPv4 address range in the format "poolName /start-ip ".

Must be a string of 1-64 characters.

ipv6-addr-pool ipv6_address_pool_name

Specify name of the IPv6 address pool.

Must be a string of 1-64 characters.

ipv6-addr-range ipv6_address_range

Specify the IPv6 address range in the format "poolName /start-ip ".

Must be a string of 1-64 characters.

ipv6-pfx-pool ipv6_prefix_pool_name

Specify name of the IPv6 prefix pool.

Must be a string of 1-64 characters.

ipv6-pfx-range ipv6_prefix_range

Specify the IPv6 prefix range in the format "poolName /start-pfx ".

Must be a string of 1-64 characters.

mac mac_address

Specify the MAC address in the format "aabb.ccdd.eeff".

Must be a string of 1-64 characters.

port-id upf_port_id

Specify port ID of the user plane function in the "upf /port-id " format.

Must be a string of 1-64 characters.

ppp-type ppp_session_type

Specify the PPP session type.

Must be one of the following:

• lac

• pta

session-id session_id

Specify the session ID information.

Must be a string of 1-64 characters.

sublabel subscriber_label

Specify the subscriber label.

Must be a string of 1-64 characters.

tunnel-id tunnel_id

Specify the tunnel ID information.

Must be a string of 1-64 characters.

upf upf_name

Specify name of the user plane function.

Must be a string of 1-64 characters.

type

Specify the type.

Must be one of the following:

• dhcp

• lns

• pppoe

• sessmgr

Clears subscriber data.

all

Specify to remove all subscriber data.

gr-instance gr_instance

Specify the subscribers from the GR instance.

imei imei_id

Specify the International Mobile Equipment Identity.

Must be a string of 15-16 characters.

namespace namespace

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

Default Value: cisco-mobile-infra:none.

nf-service nf_service

Specify the network function service under which to search.

Default Value: cisco-mobile-infra:none.

supi supi_id

Specify to remove subscriber data associated with the SUPI ID.

Must be a string of 1-63 characters.

Configures HTTP header parameters.

user-agent user_agent_header

Specify the user agent header.

Must be one of the following:

• app-name

• cluster-name

• disable

Default Value: app-name.

Configures HTTP ping parameters.

interval ping_interval

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

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

Default Value: 10000.

timeout ping_timeout

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

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

Default Value: 5000.

Configures inbound client interface parameters.

interface interface_name

Specify name of the interface. Must be one of the following: bfd, bgp, coa-nas, geo-external, geo-internal, gtpu, n4.

Configures Overload configuration parameters.

reject-code response_code

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

Must be an integer.

Configures pending request limit parameter.

request max_pending_request_limit

Specify the maximum pending request limit to allow.

Must be an integer.

Default Value: 10240.

Configures Overload configuration parameters.

reject-code response_code

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

Must be an integer.

Configures pending request limit parameter.

request max_pending_request_limit

Specify the maximum pending request limit to allow.

Must be an integer.

Default Value: 10240.

Configures outbound host ping parameter.

backoff backoff_interval

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

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

Default Value: 0.

interval ping_interval

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

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

Default Value: 0.

timeout ping_timeout

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

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

Default Value: 0.

Configures outbound client interface parameters.

interface interface_name

Specify the interface.

Configures outbound host ping parameter.

backoff backoff_interval

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

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

Default Value: 0.

interval ping_interval

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

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

Default Value: 0.

timeout ping_timeout

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

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

Default Value: 0.

Configures consecutive failure configuration parameters.

codes failure_codes

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

Must be a string.

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

count consecutive_failure_count

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

Must be an integer.

Default Value: 0.

Configures pending limit configuration.

response response_message_limit

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

Must be an integer.

Default Value: 1024.

Configures consecutive failure configuration parameters.

codes failure_codes

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

Must be a string.

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

count consecutive_failure_count

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

Must be an integer.

Default Value: 0.

Configures pending limit configuration.

response response_message_limit

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

Must be an integer.

Default Value: 1024.

Configures the commit parameters.

abort persist-id persist_id

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

Must be an integer.

confirm persist-id persist_id

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

Must be an integer.

persist-id persist_id

Specify the persistence ID for the commit operation.

Must be an integer.

Compares the running configuration to another configuration or a file.

filename[.kube | .ssh/]

Specify the file name 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.

Manipulates the software configuration information.

exclusive

Specify to enter the exclusive configuration mode.

no-confirm

Specify to apply the command without asking for confirmation.

shared

Specify to enter the shared configuration mode.

terminal

Specify to enter the terminal configuration mode.

Configures DBS parameters.

dbs dbs_name

Specify name of the DBS.

Must be a string.

Configures endpoint parameters.

endpoints endpoint_name

Specify name of the endpoint host.

Must be a string.

port port_number

Specify the port number.

Must be an integer.

Configures notification endpoint parameters.

host host_name

Specify name of the host.

Must be a string.

port port_number

Specify the port number.

Must be an integer.

Configures Session DB parameters.

Configures endpoint parameters.

endpoints endpoint_name

Specify name of the endpoint host.

Must be a string.

port port_number

Specify the port number.

Must be an integer.

Configures the product deployment parameters.

app-name application_name

Specify name of the application.

Must be a string.

cluster-name cluster_name

Specify name of the cluster.

Must be a string.

dc-name datacenter_name

Specify name of the datacenter.

Must be a string.

logical-nf-instance-id logical_nf_instance_id

Specify the logical NF instance ID.

Must be an integer.

Default Value: 0.

model deployment_model

Specify the deployment model. Default: Large.

Must be one of the following:

• small

Configures the deployment CPU resource parameter.

cpu cpu_size

Specify the CPU size in millicores.

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

Default Value: 18000.

Displays the command information.

command

Specify the command name to display 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

Creates dump of transaction history.

Configures EDR reporting parameters.

reporting reporting_status

Specify to enable or disable EDR reporting.

Must be one of the following:

• disable

• enable

Default Value: disable.

Configures subscriber EDR reporting.

subscribers subscribers_for_edr_reporting

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

Must be a string.

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

Configures EDR file parameters.

file { transaction | transaction-collision }

Specify name of the EDR file.

reporting reporting_status

Specify to enable or disable reporting of this file.

Must be one of the following:

• disable

• enable

Default Value: disable.

verbose verbosity_status

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

Must be one of the following:

• disable

• enable

Default Value: disable.

Disables procedure IDs.

procedure-id procedure_ids

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

Must be a string.

Configures EDR file flush parameters.

interval file_flush_interval

Specify, in milliseconds, the file flush interval.

Must be an integer.

Default Value: 1000.

Configures EDR file limit parameters.

count max_files_to_preserve

Specify the maximum number of files to be preserved.

Must be an integer.

Default Value: 10.

size max_single_file_size

Specify the maximum single file size limit in MB.

Must be an integer.

Default Value: 100.

Disables transaction-level procedure ID configuration.

procedure procedure_id

Specify the procedure ID value/name.

Must be a string.

Disables event IDs.

event-id event_ids

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

Must be a string.

Disables procedure-level event ID configuration.

event event_id

Specify the event ID value/name.

Must be a string.

Disables field IDs.

field-id field_ids

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

Must be a string.

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

Configures Geo Admin Controller to enable or disable maintenance mode.

mode { false | true }

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

Must be one of the following:

• false

• true

Default Value: false.

Configures Geo Admin Controller for reset role.

instance-id instance_id

Specify the instance ID for geo command.

role new_role

Specify the new role for the specified site.

Configures Geo Admin Controller for trigger failover.

failback-interval failback_interval

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

Must be a string.

instance-id instance_id

Specify the instance ID for geo command.

role new_role

Specify the new role for the specified site.

Configures configuration of pods to be monitored.

failedReplicaPercent failed_replica_precentage

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

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

pods pod_name

Specify the name of the pod to be monitored.

Must be a string.

retryCount retry_count

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

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

retryFailOverInterval retry_interval

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

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

retryInterval retry_interval

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

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

Configures remote cluster monitoring parameters.

retryCount retry_count

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

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

Default Value: 3.

retryInterval retry_interval

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

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

Default Value: 3000.

Configures traffic monitoring configuration.

thresholdCount threshold_count

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

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

Default Value: 0.

thresholdInterval threshold_interval

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

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

Default Value: 3000.

Configures VIP monitoring configuration.

Configures VIP monitoring parameters.

instance-id instance_id

Specify the instance ID.

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

Configures VIP interface monitoring parameters.

retryCount retry_count

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

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

retryFailOverInterval retry_interval

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

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

retryInterval retry_interval

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

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

vipIp vip_ip

Specify the IPv4 address.

Must be a string.

vipPort vip_port_number

Specify the diagnostic port number.

Must be an integer.

vip_interface_name

Specify name of the interface to monitor.

Must be a string.

Configures Helm configuration parameters.

default-repository default_repository_name

Specify the name of the default Helm repository.

Displays Helm release details.

Configures Helm repository parameters.

access-token helm_repo_access_token

Specify the access token for the Helm repository.

Must be a string.

helm repository helm_repo_name

Specify the name of the Helm repository.

Must be a string.

password helm_repo_password

Specify the password for the Helm repository.

url helm_repo_url

Specify the URL for the Helm repository.

Must be a string.

username helm_repo_username

Specify the username for the Helm repostiory.

Must be a string.

Displays help information for a specified 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

Configures the command history cache size.

history_size

Specify the command history cache size.

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

Displays user ID information.

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

duration

Specify the idle timeout duration in seconds.

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

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

{ false | true }

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

Must be either "false" or "true".

Configures the experimental metrics version to be enabled.

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.

Configures verbose configuration parameters.

level verbose_level

Specify the default verbosity level.

Must be one of the following:

• debug

• off

• production

• trace

Default Value: trace.

pod_type

Specify the pod type.

Must be one of the following:

• application

• load-balancer

• protocol

• service

Configures metrics verbose level parameters.

granular-labels granular_labels

Specify the granular labels.

Must be a string.

level metrics_verbose_level

Specify the metrics verbosity level.

Must be one of the following:

• debug

• off

• production

• trace

Default Value: trace.

metrics metrics_name

Specify the name of the metrics.

Must be a string.

Configures the maximum stage limit per transaction.

stage max_stage_limit

Specify the maximum stage limit per transaction.

Must be an integer.

Default Value: 100.

Configures the maximum consecutive stage limit per transaction.

stage max_consecutive_stage_limit

Specify the maximum consecutive stage limit per transaction.

Must be an integer.

Default Value: 10.

Configures the transaction loop detection parameters.

detection detection_status

Specify to enable or disable loop detection.

Must be one of the following:

• disable

• enable

Default Value: disable.

Configures the loop category.

category loop_category

Specify the category.

Configures the loop detection interval parameter.

interval loop_detect_interval

Specify, in seconds, the loop detection interval.

Must be an integer.

Default Value: 5.

Configures thresholds.

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

Configures instance ID of GR instance.

instance-id instance_id

Specify the instance ID.

Configures endpoint parameters.

certificate-name certificate_alias_name

Specify the alias name for the certificate.

endpoint endpoint_type

Specify the endpoint type. Must be one of the following: bgpspeaker, dhcp, geo, l2tp-tunnel, n4-protocol, nodemgr, pppoe, radius, sbi, sm, udp-proxy.

instancetype ep_local_interface_type

Specify the endpoint local interface type.

Must be one of the following:

• Dual

• IPv4

• IPv6

Default Value: IPv4.

internal-vip

Specify the internal VIP.

Must be a string of 1-128 characters.

loopbackEth loopbackEth

Specify the endpoint local interface name or host IP.

Must be a string.

loopbackPort loopbackPort

Specify the endpoint local port.

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.

uri-scheme uri_scheme

Specify the URI scheme.

Must be one of the following:

• http

• https

Default Value: http.

Configures K8 pod CPU configuration.

max-process max_parallel_os_threads

Specify the maximum 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.

Configures endpoint interfaces.

certificate-name certificate_alias_name

Specify the alias name for certificate.

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 loopback_eth

Specify the Loopback Eth pod interface.

Must be a string.

loopbackPort loopback_port_number

Specify the loopback 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.

Configures dispatcher queue support for the interface.

cache { false | true }

Specify whether to disable or enable retransmission cache support. To enable, set to false.

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 expiry_duration

Specify the responded cache entry expiry duration in milliseconds.

Must be an integer.

Default Value: 60000.

nonresponsive nonresponsive_duration

Specify the not responded cache entry expiry duration in milliseconds.

Must be an integer.

Default Value: 30000.

outbound { false | true }

Specify whether to disable or enble queue support for outbound messages. To enable, set to false.

Must be one of the following:

• false

• true

Default Value: true.

rate-limit rate_limit

Specify the rate limit for each queue.

Must be an integer.

Default Value: 0.

threshold outstanding_requests

Specify the outstanding requests per queue cache.

Must be an integer.

Default Value: 30000.

Configures base-port to start endpoint parameter.

start base_port_to_start_ep

Specify the base-port to start endpoint.

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

Configures SLA parameters.

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.

Configures Virtual IP parameters.

offline

Specify to mark the vip-ip as offline.

vip-interface interface_name

Specify the interface name to advertise BGP router.

Must be a string.

vip-ip vip_ip_address

Specify the IP address of the host.

Must be a string.

vip-port vip_port_number

Specify the port number.

Must be an integer.

Configures VIP IP6 parameters.

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.

Configures K8 pod memory configuration.

limit max_memory_resource

Specify the maximum memory resource in use in megabytes.

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

request memory_resource_request

Specify the memory resource request in megabytes.

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

Configures PFCP retransmission configuration.

max-retry max_retry

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

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

Default Value: 1.

timeout pfcp_retransmission_interval

Specify the PFCP retransmission interval in seconds.

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

Default Value: 15.

Configures VIP IPv6 parameters.

service-name service_name

Specify the service name.

Must be a string in the pattern [A-Za-z0-9-].*[0-9].*.

Configures endpoint interfaces.

certificate-name certificate_alias_name

Specify the alias name for certificate.

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 loopback_eth

Specify the Loopback Eth pod interface.

Must be a string.

loopbackPort loopback_port_number

Specify the loopback 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.

Configures dispatcher queue support for the interface.

cache { false | true }

Specify whether to disable or enable retransmission cache support. To enable, set to false.

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 expiry_duration

Specify the responded cache entry expiry duration in milliseconds.

Must be an integer.

Default Value: 60000.

nonresponsive nonresponsive_duration

Specify the not responded cache entry expiry duration in milliseconds.

Must be an integer.

Default Value: 30000.

outbound { false | true }

Specify whether to disable or enble queue support for outbound messages. To enable, set to false.

Must be one of the following:

• false

• true

Default Value: true.

rate-limit rate_limit

Specify the rate limit for each queue.

Must be an integer.

Default Value: 0.

threshold outstanding_requests

Specify the outstanding requests per queue cache.

Must be an integer.

Default Value: 30000.

Configures base-port to start endpoint parameter.

start base_port_to_start_ep

Specify the base-port to start endpoint.

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

Configures the Overload Control Protection critical threshold parameter.

action critical_threshold_action

Specify the action to be taken if the critical threshold is hit.

critical critical_threshold_limit

Specify the critical threshold limit for outstanding requests.

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

Configures the Overload Control Protection high threshold parameter.

action high_threshold_action

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

high high_threshold_limit

Specify the high threshold limit for outstanding requests.

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

Configures the Overload Control Protection low threshold parameter.

action low_threshold_action

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

low low_threshold_limit

Specify the low threshold limit for outstanding requests.

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

Configures the Overload Control Protection critical threshold parameter.

action critical_threshold_action

Specify the action to be taken if the critical threshold is hit.

critical critical_threshold_limit

Specify the critical threshold limit for outstanding requests.

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

Configures the Overload Control Protection high threshold parameter.

action high_threshold_action

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

high high_threshold_limit

Specify the high threshold limit for outstanding requests.

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

Configures the Overload Control Protection low threshold parameter.

action low_threshold_action

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

low low_threshold_limit

Specify the low threshold limit for outstanding requests.

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

Configures the message configuration parameters.

msg-type message_type

Specify the message type.

pending-request pending_requests

Specify the pending requests count in virtual queue.

Must be an integer.

queue-size queue_size

Specify the packet count or 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.

Configures SLA parameters.

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.

Configures Virtual IP parameters.

offline

Specify to mark the vip-ip as offline.

vip-interface interface_name

Specify the interface name to advertise BGP router.

Must be a string.

vip-ip vip_ip_address

Specify the IP address of the host.

Must be a string.

vip-port vip_port_number

Specify the port number.

Must be an integer.

Configures VIP IP6 parameters.

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.

Configures system health crash parameters.

cpu-percent cpu_percentage

Specify the CPU percentage.

Must be an integer.

Default Value: 80.

memory-in-mbs memory

Specify the memory in MB.

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.

Configures system health critical parameters.

cpu-percent cpu_percentage

Specify the CPU percentage.

Must be an integer.

Default Value: 60.

memory-in-mbs memory

Specify the memory in MB.

Must be an integer.

Default Value: 1024.

num-of-goroutine number_of_goroutine

Specify the number of goroutine per core.

Must be an integer.

Default Value: 35000.

Configures system health warn parameters.

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.

Configures VIP parameters.

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_address

Specify the VIP IPv4 address.

Must be a string.

vip-port port_number

Specify the port number.

Must be an integer.

Configures VIP IPv6 parameters.

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.

Configures instance configuration parameters.

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.

Configures IPAM instance parameters.

instance instance_id

Specify the instance ID.

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

Configures IPAM address pools.

address-pool 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 address_quarantine_queue_size

Specify the maximum number of IPs to be held in quarantine queue per-dp, per-af, per-instance. By default, it is set to 0 (no limit).

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.

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.

Configures IPv4 address ranges.

default-gateway ip_address

Specify the default gateway IP address for static pool.

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.

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.

Configures IPv4 prefix range.

default-gateway ip_address

Specify the default gateway IP address for static pool.

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

length prefix_length

Specify the IPv4 prefix length.

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

offline

Specify the IPv4 prefix range as offline.

prefix_value

Specify the IPv4 prefix.

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

Configures chunk split size parameters.

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.

Configures pool thresholds.

upper-threshold upper_threshold

Specify the upper threshold value in percentage.

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

Configures IPv6 address ranges.

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.

Configures IPv6 prefix range.

length prefix_length

Specify the IPv6 prefix length.

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

prefix_value

Specify the IPv6 prefix.

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

Configures chunk split size parameters.

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.

Configures pool thresholds.

upper-threshold upper_threshold

Specify the upper threshold value in percentage.

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

Configures IPv6 prefix ranges.

offline

Specify the IPv6 prefix range as offline.

prefix-length prefix_length

Specify the prefix length.

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

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.

Configures chunk split size parameters.

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.

Configures pool thresholds.

upper-threshold upper_threshold

Specify the upper threshold value in percentage.

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

Configures IPAM static pool parameters.

enable

Specify to set pool as static.

user-plane user_plane

Specify to associate user plane for this static 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.

Configures the minimum number of addresses to reserve per UPF, per NM, per pool/tag.

ipv4-addr reserve_min_ipv4_address

Specify the minimum number of IPv4 addresses to reserve.

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

ipv6-addr reserve_min_ipv6_address

Specify the minimum number of IPv6 addresses to reserve.

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

ipv6-prefix reserve_min_ipv6_prefix

Specify the minimum number of IPv6 prefix to reserve.

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

Configures pool-datastore source selection.

local

Specify to use local address pool datastore.

Configures external IPAM server for pool information.

host ip_address

Specify the 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 the 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

Configures global upper thresholds.

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.

Displays IPAM data-plane allocations.

dp-name dataplane_name

Specify name of the dataplane.

Must be a string.

Displays data-plane tag-related allocations.

dp-tag dp_tag

Specify the dataplane name with tag.

Must be a string.

Displays pool allocation information.

pool-name pool_name

Specify name of the pool.

Must be a string.

Suspends the jobs that are running in the background.

job_id

Specify the job ID for suspending the corresponding job.

Must be an integer.

Configures Tracing configuration parameters.

coverage-build { false | true }

Specify whether to disable or enable coveage build.

Must be one of the following:

• false

• true

Default Value: false.

datastore-endpoint datastore_endpoint

Specify the Datastore Endpoint configuration. For example, hostname :port .

Must be a string of 1-128 characters.

Default Value: datastore-ep-session:8882.

etcd-endpoint etcd_endpoint

Specify the Etcd Endpoint configuration. For example, hostname :port .

Must be a string of 1-128 characters.

Default Value: etcd:2379.

Configures Tracing configuration parameters.

append-messages { false | true }

Specify whether to append tracing messages.

Must be one of the following:

• false

• true

Default Value: true.

enable-trace-percent tracing_percentage

Specify the tracing percentage.

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

Default Value: 100.

enable

Specify to enable tracing.

endpoint tracing_endpoint

Specify the Tracing Endpoint configuration. For example, hostname :port .

Must be a string of 1-128 characters.

Default Value: jaeger-collector:9411.

Configures K8 node affinity label pod group configuration.

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.

pod_group

Specify the pod group for the VMs.

Must be one of the following:

• cdl-layer

• oam-layer

• protocol-layer

• service-layer

Configures Kubernetes parameters.

image-pull-secrets image_pull_secrets

Specify the image pull secrets stored within K8s.

Must be a string.

ingress-host-name ingress_host_name

Specify the generic ingress host name.

Must be a string.

name k8s_cluster_name

Specify name of the K8s cluster.

Must be a string.

namespace k8s_namespace

Specify the K8s namespace for the network function.

Must be a string.

nf-name nf_name

Specify the NF deployed in this k8s namespace.

Must be a string.

registry image_registry

This keyword is deprecated.

Must be a string.

single-node { false | true }

Specify to enable or disable single node deployment.

Must be one of the following:

• false

• true

Default Value: false.

use-volume-claims { false | true }

Specify to enable or disable using volume claims when deploying.

Must be one of the following:

• false

• true

Default Value: false.

Configures list of k8s nodes.

node-type node_type

Specify the K8s node type.

Must be a string.

worker-type worker_type

Specify the k8s worker type.

Must be a string.

k8s_node_name

Specify name of the K8s node.

Must be a string.

Enables or disables automatic querying for leaf values.

{ false | true }

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

Must be either "false" or "true".

Configures the license parameters for the VNF deregistration.

deregister

Specify to deregister the VNF for smart licensing.

Configures the license parameters for the VNF registration.

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.

Configures the license parameters for the VNF renewal.

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.

Configures GR instance for current instance.

instance gr_instance_id

Specify the GR instance ID of current instance.

Enables async logging.

buffer-size buffer_size

Specify the buffer size for async logging.

Must be an integer.

Enables async logging.

buffer-size buffer_size

Specify the buffer size for async logging.

Must be an integer.

Enables async logging.

buffer-size buffer_size

Specify the buffer size for async logging.

Must be an integer.

Enables async logging.

buffer-size buffer_size

Specify the buffer size for async logging.

Must be an integer.

Configures error logging parameters.

stack status

Specify to enable or disable error stack.

Must be one of the following:

• disable

• enable

Default Value: enable.

Configures the logging level.

application application_log_level

Specify the application logging level.

Must be one of the following:

• debug

• error

• info

• off

• trace

• warn

monitor-subscriber monitor_subscriber_log_level

Specify the monitor subscriber logging level.

Must be one of the following:

• debug

• error

• info

• off

• trace

• warn

tracing tracing_log_level

Specify the tracing logging level.

Must be one of the following:

• debug

• error

• info

• off

• trace

• warn

transaction transaction_log_level

Specify the transaction logging level.

Must be one of the following:

• debug

• error

• info

• off

• trace

• warn

Configures the log name.

name log_name

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

Must be a string.

Configures the logging level.

application application_log_level

Specify the application logging level.

Must be one of the following:

• debug

• error

• info

• off

• trace

• warn

monitor-subscriber monitor_subscriber_log_level

Specify the monitor subscriber logging level.

Must be one of the following:

• debug

• error

• info

• off

• trace

• warn

tracing tracing_log_level

Specify the tracing logging level.

Must be one of the following:

• debug

• error

• info

• off

• trace

• warn

transaction transaction_log_level

Specify the transaction logging level.

Must be one of the following:

• debug

• error

• info

• off

• trace

• warn

Configures the transaction logging parameters.

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_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.

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

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.

Configures the SMF to monitor the protocol.

interface interface_name

Specify the name of interface on which PCAP is captured.

Must be a string.

capture-duration duration

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

Must be an integer.

Configures the SMF to monitor the subscribers.

supi supi

Specify the subscriber identifier.

Must be a string.

capture-duration duration

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

Must be an integer.

filename file_name

Specify the path of the file name to be dumped.

Must be a string.

Configure CA certificate parameters.

ca-certificates cert_alias_name

Specify the alias name of the certificate.

Must be a string.

cert-data cert_data

Specify the certificate data in PEM format.

Must be a string.

Displays certificate status information.

Configures certificate parameters.

cert-data cert_data

Specify the certificate data in PEM format.

Must be a string.

certificates cert_alias_name

Specify the alias name of the certificate.

Must be a string.

private-key private_key

Specify the certificate private key in PEM format.

Must be a string.

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

Configures whether or not to paginate CLI command output.

{ false | true }

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

Must be either "false" or "true".

Configures AAA profiles.

aaa_profile_name

Specify name of the AAA profile.

Must be a string of 1-128 characters.

Configures accounting configuration parameters.

method-order method_list_order

Specify the method list order.

Must be one of the following:

• radius

-Or-

Must be a string of 1-128 characters.

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

Configures authentication parameters.

method-order method_list_order

Specify the method list order.

Must be one of the following:

• radius

-Or-

Must be a string of 1-128 characters.

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

Configures authorization parameters.

password default_password

Specify the default password.

Must be a string in the bng-special-str pattern. For information on the bng-special-str pattern, see the Input Pattern Types chapter.

Configures authorization type subscriber.

method-order method_list_order

Specify the method list order.

Must be one of the following:

• radius

-Or-

Must be a string of 1-128 characters.

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

Configures the default user name.

format attribute_format

Specify the attribute format.

identifier identifier_type

Specify the identifier type.

Must be one of the following:

• addr

• circuit-id-tag

• client-mac-address-custom1

• client-mac-address-custom2

• client-mac-address-ietf

• client-mac-address-raw

• client-mac-address

• dhcp-client-id-spl

• dhcp-client-id

• dhcp-user-class

• dhcp-vendor-class

• dhcpv4-client-id-spl

• dhcpv4-vendor-class

• dhcpv6-client-id-ent-ident

• dhcpv6-interface-id

• dhcpv6-vendor-class-string

• inner-vlan-id

• outer-vlan-id

• physical-adapter

• physical-chassis

• physical-port

• physical-slot

• physical-subslot

• port-type

• pppoe-session-id

• remote-id-tag

• service-name

• user-plane

• username