SMF Executive Commands
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.
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 the IPAM operational data.
Privilege Level
Security Administrator, Administrator
Command Mode
Exec
Syntax
clear ipam Usage Guidelines
Use this command to clear the IPAM operational data.
clear subscriber
Clears the subscriber data.
Privilege Level
Security Administrator, Administrator
Command Mode
Exec
Syntax
clear subscriber Usage Guidelines
Use this command to clear the subscriber data.
commit
Configures the commit parameters.
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.
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.
dump
Removes the transaction history.
Privilege Level
Security Administrator, Administrator
Command Mode
Exec
Syntax
dump transactionhistory Usage Guidelines
Use this command to remove the transaction history.
exit
Exits the current configuration mode and returns to the previous configuration mode.
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.
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.
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.
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.
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.
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 ] interface interface_name
Specify the name of interface on which PCAP is captured.
Must be a string.
capture-duration duration
Specify the duration, in seconds, during which PCAP is captured. The default value is 300 seconds.
Must be an integer.
Usage Guidelines
Use this command to monitor the protocol.
monitor subscriber
Configures the SMF to monitor the subscribers.
Privilege Level
Security Administrator, Administrator
Command Mode
Exec
Syntax
monitor subscriber supi supi [ capture-duration duration ] | subscriber-dump filename file_name | subscriber-list supi supi
Specify the subscriber identifier.
Must be a string.
capture-duration duration
Specify the duration, in seconds, during which PCAP is captured. The default value is 300 seconds.
Must be an integer.
filename file_name
Specify the path of the file name to be dumped.
Must be a string.
Usage Guidelines
Use this command to monitor the subscribers.
no
Restores the command history cache size to its default setting. See the history command.
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.
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.
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.
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.
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.
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-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.
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.
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.
Feedback