Both yp-shell and yangcli-pro provide a command line interface to netconfd-pro, but there are some important differences.
yp-shell is the optional embedded CLI for the netconfd-pro server which is enabled by default.
yangcli-pro is a NETCONF client that is used to connect to, manage, and configure multiple NETCONF servers.
yp-shell and yangcli-pro share many of the same commands and features.
The table below summarizes the commands available to each program. A star '*' is printed to indicate server commands.
To display the full description of a command, at the command line of yangcli-pro or yp-shell: type:
user@localhost> help full <command_name>
| yangcli-pro | yp-shell | description |
| action | action | Invoke a YANG action. |
| alias | alias | Show or set a specific yangcli-pro command alias. |
| aliases | aliases | Manage the yangcli-pro command aliases. |
| auto-test | Run automatic edit testing on the specified object | |
| backup* | backup* | Backup the current running configuration to a file on the device. |
| cache* | Clear 1 or all entries from the YANG module cache. | |
| cancel-commit* | cancel-commit* | This operation is used to cancel an ongoing confirmed commit. |
| cancel-subscription* | Cancel a notification subscription for the session, if this session has an active subscription. | |
| cd | Change the current working directory. | |
| clear | clear | Clear the screen in interactive mode. |
| clear-eventlog* | clear-eventlog* | Delete any events stored in the eventlog for the specified event stream. This operation has no affect if the event stream does not have any stored events or its eventlog is not enabled. |
| close-session* | Request graceful termination of a NETCONF session. | |
| commit* | commit* | When a candidate configuration's content is complete, the configuration data can be committed, publishing the data set to the rest of the device and requesting the device to conform to the behavior described in the new configuration. |
| config | config | Enter the configuration mode for the current session. |
| connect | Connect to a NETCONF server. | |
| copy-config* | copy-config* | Create or replace an entire configuration datastore with the contents of another complete configuration datastore. If the target datastore exists, it is overwritten. Otherwise, a new one is created, if allowed. If a NETCONF peer supports the :url capability (Section 8.8), the 'url' element can appear as the <source> or <target> parameter. |
| create | create | Create some NETCONF config data with the edit-config operation. |
| create-subscription* | The command to create a notification subscription. | |
| delete | delete | Delete some NETCONF config data with the edit-config operation. Delete all instances of a leaf-list. |
| delete-all | delete-all | Delete some NETCONF config data with the edit-config operation. Delete all instances of a leaf-list or list object. |
| delete-backup* | delete-backup* | Delete the specified backup file on the device. |
| delete-config* | delete-config* | Delete a configuration datastore. The 'running' configuration datastore cannot be deleted. |
| device-cfg | Access a device configuration. | |
| devices-cfg | Controls access to the saved devices file. | |
| discard-changes* | discard-changes* | If the client decides that the candidate configuration should not be committed, the 'discard-changes' operation can be used to revert the candidate configuration to the current running configuration. |
| edit-config* | edit-config* | The 'edit-config' operation loads all or part of a specified configuration to the specified target configuration. This operation allows the new configuration to be expressed in several ways, such as using a local file, a remote file, or inline. |
| elif | Start an intermediate block in a conditional statement. | |
| else | Start the last block in a conditional statement. | |
| enable | enable | Use 'enable' to enter enable mode for yp-shell. |
| end | End an 'if' command block or a 'while' command block. | |
| eval | Evaluate an XPath expression locally on the manager. All local variables will be available to the session context, in the following precedence: 1) current script run level 2) global variable | |
| event-handler-cfg | Access an event handler mapping configuration. | |
| event-handlers-cfg | Controls access to the saved event-handlers file | |
| eventlog | Access the notification event log. | |
| exit | exit | Exit the current configuration level for the current session. |
| fill | Fill a value for reuse in a NETCONF PDU or other operation. | |
| get* | get* | Retrieve running configuration and device state information. |
| get-bulk* | get-bulk* | Retrieve multiple list entries at a time |
| get-config* | get-config* | Retrieve all or part of a specified configuration. |
| get-ha-status* | get-ha-status* | Get the YP-HA status information for this server. |
| get-locks | Get a lock for the running configuration and the candidate and startup configurations, if needed. If all the locks cannot be obtained, then release all of them (all-or-nothing). The entire operation must be completed within the lock timeout interval, if it is set. | |
| get-module-tags* | get-module-tags* | Get the list of configured module-tags. |
| get-schema* | get-schema* | This operation is used to retrieve a schema from the NETCONF server. |
| get-support-save* | get-support-save* | Retrieve the support-save info from the server. |
| get-walk | get-walk | Walk the entries of a YANG list using the netconfd-pro <get-bulk> operation. This command will send <get-bulk> requests to the server until the entire list has been retrieved or the user quits the walk. |
| group | Manage the yangcli-pro session groups. A group name is not allowed to have the same name as any session name. This allows the 'session set-current' command to select a group or an individual session. | |
| help | help | Print the yangcli-pro help text. |
| history | history | Access the command line history buffer. |
| if | Evaluate an XPath expression locally on the manager and execute the block of commands that follow if the expression is true. The block ends when a matching 'elif', 'else', or 'end' command is reached. | |
| insert | insert | Insert some NETCONF config data with the edit-config operation. |
| kill-session* | kill-session* | Force the termination of a NETCONF session. |
| list | List some NETCONF info. | |
| load* | load* | Load a module into the server, if it is not already loaded. |
| load-bundle* | load-bundle* | Load a SIL bundle into the server, if it is not already loaded. |
| lock* | lock* | The lock operation allows the client to lock the configuration system of a device. Such locks are intended to be short-lived and allow a client to make a change without fear of interaction with other NETCONF clients, non-NETCONF clients (e.g., SNMP and command line interface (CLI) scripts), and human users. |
| log-debug | Write a message to the output log if the log-level is greater or equal to 'debug'. | |
| log-error | Write a message to the output log if the log-level is greater or equal to 'error'. | |
| log-info | Write a message to the output log if the log-level is greater or equal to 'info'. | |
| log-warn | Write a message to the output log if the log-level is greater or equal to 'warn'. | |
| merge | merge | Merge some NETCONF config data with the edit-config operation. |
| mgrload | mgrload | Load a module or other file into the client. |
| nvsave | nvsave | Save the running datastore to the startup datastore. |
| partial-lock* | A NETCONF operation that locks parts of the running datastore. | |
| partial-unlock* | A NETCONF operation that releases a previously acquired partial-lock. | |
| pwd | Print the current working directory. | |
| quit | quit | Quit the yangcli-pro application. |
| recall | recall | Recall the specified command line history buffer entry into the current command line. |
| record-test | Use the unit test-suite automatic test recording feature. Only one test can be recorded at a time. | |
| refresh-backup-dir* | refresh-backup-dir* | Refresh the /netconf-state/backup-files subtree. This operation allows the backup file directory contents to be altered at run-time outside the control of the server. The 'backup-file' list entries within the 'backup-files' container will be refreshed. |
| refresh-library | If the YANG modules available on disk changes while the program is running, then this command can be used to refresh the module version list used to determine the 'best-match' for imports. | |
| release-locks | Unlock all the server databases that were previously locked with the get-locks command. | |
| remove | remove | Remove some NETCONF config data with the edit-config operation. Remove all instances of a leaf-list. |
| remove-all | remove-all | Remove some NETCONF config data with the edit-config operation. Remove all instances of a leaf-list or list object. |
| replace | replace | Create some NETCONF config data with the edit-config operation. |
| restore* | restore* | Restore a saved configuration on the device to the running configuration. |
| run | Internal command to run a script. | |
| run-shell | Internal command to run a shell script. | |
| save | save | Meta command to save configuration edits. |
| schema-server-cfg | Access a schema-server configuration | |
| schema-servers-cfg | Controls access to the saved schema-servers file | |
| session | Access an active session. | |
| session-cfg | Access a session configuration. | |
| sessions-cfg | Controls access to the saved sessions file. | |
| set-log-level* | set-log-level* | Sets the server log verbosity level. |
| sget | sget | Get some NETCONF running config or state data with the get operation, using an optional subtree filter. |
| sget-config | sget-config | Get some NETCONF config data with the get-config operation, using an optional subtree filter. |
| sget-data | sget-data | Get some NETCONF datastore data with the <get-data> operation, using an optional subtree filter. The server must support the <get-data> operation from the ietf-netconf-nmda module. |
| show | show | Local show command for yangcli-pro session info. |
| sleep | sleep | Pause for a number of seconds. |
| start-rpc-timing | Start collecting RPC timing statistics for the current session. Will set $$echo-replies to false and $$time-rpcs to true. Will record stats to output file if specified. | |
| start-session | Start an active session from the specified configured session. | |
| start-timer | Start a timer to do simple performance measurements. | |
| stop-rpc-timing | Stop collecting RPC timing statistics for the current session. Will set session $$echo-replies to true and $$time-rpcs-state to false. Will close the stats file, if opened. | |
| stop-session | Terminate an active session. | |
| stop-timer | Stop a timer and output the delta value. | |
| terminal | terminal | Configure the terminal settings |
| test-suite | Use the unit test-suite feature. | |
| unload* | unload* | Unload a module from the server. Remove the associated server instrumentation library (SIL). Remove any data nodes in the system from the module. Remove the module from the server capabilities and NETCONF monitoring data. Remove the module namespace from the system. |
| unload-bundle* | unload-bundle* | Unload a SIL bundle from the server, if it is loaded. |
| unlock* | unlock* | The unlock operation is used to release a configuration lock, previously obtained with the 'lock' operation. |
| unset | unset | Delete a specific yangcli-pro command alias. |
| update-config | update-config | Update the configuration cache for the current session. |
| user-cfg | Access a user configuration. | |
| users-cfg | Controls access to the saved users file. | |
| uservars | Manage the yangcli-pro user variables. | |
| validate* | validate* | Validates the contents of the specified configuration. |
| while | Evaluate an XPath expression locally on the manager and execute the block of commands that follow while the expression is true. The block ends when a matching 'end' command is reached. | |
| xget | xget | Get some NETCONF running config or state data with the get operation, using an optional XPath filter. |
| xget-config | xget-config | Get some NETCONF config data with the get-config operation, using an optional XPath filter. |
| xget-data | xget-data | Get some NETCONF datastore data with the <get-data> operation, using an optional XPath filter. The server must support the <get-data> operation from the ietf-netconf-nmda module. |