Ultra Cloud Core 5G Policy Control Function, Release 2023.01 - CLI Command Reference

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Book Contents
Find Matches in This Book
Available Languages
Download Options

Book Title

Ultra Cloud Core 5G Policy Control Function, Release 2023.01 - CLI Command Reference

Chapter Title

Mobile Policy Executive Commands

Results

Updated:
January 27, 2023

Chapter: Mobile Policy Executive Commands

Mobile Policy Executive Commands

aaa authentication

Configures the AAA-based user management parameters.

Command Modes

Exec

Syntax

aaa authentication users user admin change-password { old-password old_password | new-password new_password | confirm-password new_password }

old-password old_password

Specify the old password.

Must be a string.

new-password new_password

Specify the new password.

Must be a string.

confirm-password new_password

Confirm the new password.

Must be a string.

Usage Guidelines

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

cd

Changes the current working directory.

Command Modes

Exec

Syntax

cd directory.ssh

directory

Specify the directory name.

Must be a string.

Usage Guidelines

Use this command to change the current working directory.

cdl clear sessions

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

Command Modes

Exec

Syntax

cdl clear sessions [ db-name database | filter filter | map-id map_id | slice-name slice_name ]

db-name database

Specify the database name to be queried.

Must be a string of minimum one to maximum 16 characters.

filter filter

Specify the filter.

map-id map_id

Specify the map-id to clear the data for a map.

Must be an integer.

slice-name slice_name

Specify the slice name to be queried.

Must be a string of minimum one to maximum 16 characters.

Usage Guidelines

Use this command to clear the data from the Cisco Data Layer (CDL) datastore.

cdl clear sessions filter

Clears the Cisco Data Layer (CDL) datastore sessions based on the filter criteria.

Command Modes

Exec

Syntax

cdl clear sessions filter { condition { ends-with | match | starts-with } | key  key_value}

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

Specify the query expression.

key key_value

Specify the key value.

Usage Guidelines

Use this command to clear CDL sessions based on the filter criteria.

cdl show indexes

Displays the indexes of the database from the datastore

Command Modes

Exec

Syntax

cdl show indexes { db-name database | key key_value | limit maximum_indexes | map-id map_id | slice-name slice_name }

db-name database_name

Specify to database name to be queried.

Must be a string.

key key_value

Specify to query value.

limit maximum_indexes

Specify the maximum number of indexes to be displayed.

Default value is 500.

map-id map_id

Specify the map-id to clear the data for a map.

Must be an integer.

slice-name slice_name

Specify the slice name to be queried.

Usage Guidelines

Use this command to display the database indexes.

cdl show sessions

Displays the session data from the datastore.

Command Modes

Exec

Syntax

cdl show sessions { count | detailed | summary }

count

Specify to display the session count information.

Must be a string.

detailed

Specify to display the session details with data.

Must be a string.

summary

Specify to display the session details without data.

Must be a string.

Usage Guidelines

Use this command to display the session data from the datastore.

cdl show status

Displays the status of the database from the datastore

Command Modes

Exec

Syntax

cdl show status db-name database_name

db-name database_name

Specify to display the status of the database.

Must be a string.

Usage Guidelines

Use this command to display the status of the database from the datastore.

commit abort

Aborts the commit operation associated to the persist-ID.

Command Modes

Exec

Syntax

commit { abort persist-id persist_id }

abort persist-id persist_id

Specify to abort commit. Specify the persist-ID.

Must be an integer.

Usage Guidelines

Use this command to abort the commit operation.

commit confirm

Confirms the commit operation for the persist-ID.

Command Modes

Exec

Syntax

commit confirm persist-id persist_id

persist-id persist_id

Specify to persist-ID for which the commit operation must be confirmed.

Must be an integer.

Usage Guidelines

Use this command to confirm the commit operation for the persist-ID.

commit persist-ID

Displays the commits associated to the persist-ID.

Command Modes

Exec

Syntax

commit persist-id persist_id

persist-id persist_id

Specify to confirm the commit operation relevant to the persist-ID.

Must be an integer.

Usage Guidelines

Use this command to display the commits associated to the persist-ID.

compare

Compares running configuration to another configuration or a file.

Command Modes

Exec

Syntax

compare file {  filename [.kube | .ssh] | another_configuration }

filename [.kube | .ssh] |

Specify the file name.

Must be a string.

another_configuration

another_configuration

Specify the configuration to be compared against.

Must be a string.

Usage Guidelines

Use this command to configure the file that must be compared.

config exclusive

Manipulates the software configuration information to enter the exclusive configuration mode.

Command Modes

Exec

Syntax

config exclusive [ no-confirm ]

exclusive

Specify to enter the exclusive configuration mode.

no-confirm

Specify to apply the command without asking for confirmation.

Usage Guidelines

Use this command to manipulate the software configuration information to enter the exclusive configuration mode.

config shared

Manipulates the software configuration information to enter the shared configuration mode.

Command Modes

Exec

Syntax

config shared [ no-confirm ]

shared

Specify to enter the shared configuration mode.

no-confirm

Specify to apply the command without asking for confirmation.

Usage Guidelines

Use this command to manipulate the software configuration information to enter the shared configuration mode.

config terminal

Manipulates the software configuration information to enter the terminal configuration mode.

Command Modes

Exec

Syntax

config terminal [ no-confirm ]

terminal

Specify to enter the terminal configuration mode.

no-confirm

Specify to apply the command without asking for confirmation.

Usage Guidelines

Use this command to manipulate the software configuration information to enter the terminal configuration mode.

deployment add

Configures the deployment parameters such as the list of cluster-name, and external IP and port number of the unified-api service.

Command Modes

Exec

Syntax

deployment add config { cluster-name cluster_name | port port_number | unified-api-external-ip external_ip }

cluster-name cluster_name

Specify the cluster name.

Must be a string.

port port_number

Specify the port number of the unified-api service.

Must be an address.

unified-api-external-ip external_ip

Specify the external IP of the unified-api service.

Must be an address.

Usage Guidelines

Use this command to configure the deployment parameters such as the list of cluster-name, and external IP and port number of the unified-api service.

deployment remove-config

Removes the deployment configuration file.

Command Modes

Exec

Syntax

deployment remove-config

remove-config

Specify to remove the configuration file.

Must be a string.

Usage Guidelines

Use this command to remove the deployment configuration file.

deployment show-config

Displays the deployment environment parameters.

Command Modes

Exec

Syntax

deployment show-config

show-config

Specify to display the deployment parameters.

Must be a string.

Usage Guidelines

Use this command to display the deployment environment parameters.

describe

Displays the command information.

Command Modes

Exec

Syntax

describe command

command

Specify the command name.

Must be a string.

Usage Guidelines

Use this command to view command information.

exit

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

Command Modes

Exec

Syntax

exit

Usage Guidelines

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

help

Displays help information for specified command.

Command Modes

Exec

Syntax

help command

command

Specify the command name to display help information..

Must be a string.

Usage Guidelines

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

history

Configures the command history cache size.

Command Modes

Exec

Syntax

history history_size

history_size

Specify the command history cache size.

Must be an integer.

Usage Guidelines

Use this command to configure the command history cache size.

id

Displays user ID information.

Command Modes

Exec

Syntax

id

Usage Guidelines

Use this command to view user ID information.

idle-timeout

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

Command Modes

Exec

Syntax

idle-timeout idle_timeout

idle_timeout

Specify the idle timeout duration in seconds.

Usage Guidelines

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

ignore-leading-space

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

Command Modes

Exec

Syntax

ignore-leading-space { false | true }

ignore-leading-space { false | true }

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

Must be either "false" or "true".

Usage Guidelines

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

job

Suspends the jobs that are running in the background.

Command Modes

Exec

Syntax

job stop job_id

job_id

Specify the job ID.

Must be an integer.

Usage Guidelines

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

leaf-prompting

Enables or disables automatically querying for leaf values.

Command Modes

Exec

Syntax

leaf-prompting { false | true }

leaf-prompting { false | true }

Specify false to disable leaf prompting, true to enable.

Must be either "false" or "true".

Usage Guidelines

Use this command to automatically query for leaf values.

license smart register

Registers the VNF for Smart Licensing.

Command Modes

Exec

Syntax

license smart register [ force ] idtoken idtoken

register

Specify to register the VNF for Smart Licensing.

Must be a string.

force

Specify to enable the force registration of the agent.

Must be a string.

idtoken

Specify the ID token to register the agent with.

Must be an integer.

Usage Guidelines

Use this command to register the VNF for Smart Licensing.

license smart deregister

Deregisters the VNF for Smart Licensing.

Command Modes

Exec

Syntax

license smart deregister

deregister

Specify to deregister the VNF for Smart Licensing.

Must be a string.

Usage Guidelines

Use this command to deregister the VNF for Smart Licensing.

license smart renew

Renew smart agent IDs and authentication.

Command Modes

Exec

Syntax

license smart renew { ID | auth }

renew

Specify to renew the smart agent IDs and authentication.

Must be an integer.

ID

Specify the ID to renew smart agent license registration information

auth

Specify to initiate a manual update of the license usage information with Cisco

Usage Guidelines

Use this command to configure the license parameters for the NF.

logout session

Logs out a specific session.

Command Modes

Exec

Syntax

logout session session

session session

Specify the session from the possible completion options.

Must be a string.

Usage Guidelines

Use this command to log out of a specific session.

logout user

Logs out a specific user from all sessions.

Command Modes

Exec

Syntax

logout user user

user user

Specify the user from the possible completion options.

Must be a string.

Usage Guidelines

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

no

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

Command Modes

Exec

Syntax

no history

Usage Guidelines

Use this command to configure the command history cache size to its default setting. Refer to the history command.

paginate

Configures whether or not to paginate CLI command output.

Command Modes

Exec

Syntax

paginate { true | false }

paginate { true | false }

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

Must be either "false" or "true".

Usage Guidelines

Use this command to paginate the command output.

quit

Exits the management session.

Command Modes

Exec

Syntax

quit

Usage Guidelines

Use this command to exit the management session.

screen-length

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

Command Modes

Exec

Syntax

screen-length number_of_rows

number_of_rows

Specify the number of rows.

Must be an integer.

Usage Guidelines

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

screen-width

Configures the number of columns that the terminal screen displays.

Command Modes

Exec

Syntax

screen-width number_of_columns

number_of_columns

Specify the number of columns.

Must be an integer.

Usage Guidelines

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

send

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

Command Modes

Exec

Syntax

send user message

user

Specify the user to whom the message must be sent.

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

message

Specify the message that must be sent.

Must be a string.

Usage Guidelines

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

show

Displays the system information.

Command Modes

Exec

Syntax

show system_component

system_component

Specify the component to view the information.

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

Usage Guidelines

Use this command to view the system information.

show-defaults

Configures whether to display default values when showing the configuration.

Command Modes

Exec

Syntax

show-defaults { false | true }

show-defaults { false | true }

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

Must be either "false" or "true".

Usage Guidelines

Use this command to view default values when viewing the configuration commands.

smiuser add-group

Configures the SMI group parameters.

Command Modes

Exec

Syntax

smiuser add-group groupname group_name

groupname group_name

Specify the group name in PAM.

Must be a string.

Usage Guidelines

Use this command to configure the SMI group parameters.

smiuser add-user

Configures the SMI user account parameters.

Command Modes

Exec

Syntax

smiuser add-user username username password password

username username

Specify the username.

Must be a string.

password password

Specify the user password.

Must be a string.

Usage Guidelines

Use this command to configure the smiuser parameters.

smiuser assign-user-group

Assigns the SMI user group.

Command Modes

Exec

Syntax

smiuser assign-user-group groupname group_name username username

username username

Specify the user name in PAM.

Must be a string.

groupname group_name

Specify the group name in PAM.

Must be a string.

Usage Guidelines

Use this command to assign the SMI user group.

smiuser change-password

Allows resetting the SMI password.

Command Modes

Exec

Syntax

smiuser change-password { username username | current_password current_password | new_password new_password | confirm_password new_password | password_expire_days expire_days }

username username

Specify the username.

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.

confirm_password new_password

Confirm the new password.

Must be a string.

password_expire_days expire_days

Specify the number of days before password expires.

Must be an integer.

Usage Guidelines

Use this command to reset the SMI password.

smiuser change-password-age

Configures the number of days before which the password expires.

Command Modes

Exec

Syntax

smiuser change-password-age [ usernameusername|password_expire_daysexpire_days]

username username

Specify the username.

Must be a string.

password_expire_days expire_days

Specify the number of days before which the password expires.

Must be an integer.

Usage Guidelines

Use this command to configure the number of days before which the password expires.

smiuser change-self-password

Resets the SMI user accounts self-password.

Command Modes

Exec

Syntax

smiuser change-self-password { current_password current_password | new_password
new_password | confirm_password new_password | password_expire_days expire_days
}

current_password current_password

Specify the current password.

Must be a string.

new_password new_password

Specify the new password.

Must be a string.

confirm_password new_password

Confirm the new password.

Must be a string.

password_expire_days expire_days

Specify the number of days before which the password expires.

Must be an integer.

Usage Guidelines

Use this command to reset the SMI user accounts self-password.

smiuser delete-group

Deletes the SMI group.

Command Modes

Exec

Syntax

smiuser delete-group groupname group_name

groupname group_name

Specify the group name.

Must be a string.

Usage Guidelines

Use this command to delete the SMI user group.

smiuser delete-user

Deletes the SMI user.

Command Modes

Exec

Syntax

smiuser delete-user username username

username username

Specify the username.

Must be a string.

Usage Guidelines

Use this command to delete the SMI user.

smiuser show-user

Displays the SMI user details.

Command Modes

Exec

Syntax

smiuser show-user username username

username username

Specify the username.

Must be a string.

Usage Guidelines

Use this command to display the SMI user details.

smiuser unassign-user-group

Configures the SMI user's unassign user group.

Command Modes

Exec

Syntax

smiuser unassign-user-group groupname groupname_pam username username_pam

groupname groupname_pam

Specify the groupname in PAM.

Must be a string.

username username_pam

Specify the username in PAM.

Must be a string.

Usage Guidelines

Use this command to configure the SMI user's unassign user group.

smiuser update-password-length

Configures the minimum password length.

Command Modes

Exec

Syntax

smiuser update-password-length length password_length

length password_length

Specify the minimum password length.

Must be an integer.

Usage Guidelines

Use this command to configure the minimum password length.

subscriber

Configures the subscriber parameters.

Command Modes

Exec

Syntax

subscriber session [ imsi imsi_value | msisdn msisdn_value ]

imsi imsi_value

Specify the IMSI value.

Must be an integer.

msisdn msisdn_value

Specify the MSISDN value.

Must be an integer.

Usage Guidelines

Use this command to configure the subscriber parameters.

system ops-center

Suspends the ops center diagnostics synching process.

Command Modes

Exec

Syntax

system ops-center stop

ops-center stop

Specify to stop the synching process.

Must be a string.

Usage Guidelines

Use this command to suspend the ops center diagnostics synching process.

system sync

Configures automatic synching.

Command Modes

Exec

Syntax

system ops-center stop

synch { start | stop }

Specify to start or stop the synching process.

Must be either "start" or "stop".

Usage Guidelines

Use this command to configure automatic synching.

system upgrade

Enforces the product upgrade.

Command Modes

Exec

Syntax

system upgrade

Usage Guidelines

Use this command to enforce the product upgrade.

system uuid-override

Enforce the UUID to a new value.

Command Modes

Exec

Syntax

system uuid-override new-uuid uid

new-uuid uid

Specify the ID Token to register the agent with.

Must be a string.

Usage Guidelines

Use this command to enforce the UUID to a new value.

system ops-center-debug

Configures the Ops Center debugging process.

Command Modes

Exec

Syntax

system ops-center-debug { start | stop }

ops-center-debug { start | stop }

Specify to start or stop the ops-center debugging process.

Must be either "start" or "stop".

Usage Guidelines

Use this command to configure the Ops Center debugging process.

terminal

Configures the terminal parameters.

Command Modes

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

timestamp

Enables or disables the timestamp parameters.

Command Modes

Exec

Syntax

timestamp { enable | disable }

timestamp { enable | disable }

Specify the configuration to enable or disable the timestamp display.

Usage Guidelines

Use this command to enable or disable the timestamp parameters.

who

Displays information on currently logged on users.

Command Modes

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, Protocol, Date, and Mode information.

Was this Document Helpful?

FeedbackFeedback

Contact Cisco