RPC Methods

Show or set a specific yangcli command alias.

* Show all aliases in memory (same as aliases):

  yangcli>  alias

* Show one alias 'foo':

  yangcli>  alias foo

* Set one alias; make sure there is no whitespace
  between the '=' char and either string.  If the value
  has whitespace, it must be quoted. If the equals sign
  is present, then a valid value string must be present.

  Quotes will be preserved if used:
    * Single quotes can appear within doubled-quoted
      strings but not any double quotes.
    * Double quotes can appear within single-quoted strings
      but not any single quotes.

  The first token in a plain command or the first token
  in the right-hand-side expression in an assignment
  statement can be an alias.

  The alias name must exact match the token.
  A new command line will be constructed replacing
  the alias name with its value.  The new command
  line will then be parsed as usual.

  yangcli>  alias s=show
  yangcli>  alias getfoo='sget-config source=running /top/foo'

* Aliases can override real commands, so be careful
 not to unintentionally alter real commands.

  yangcli>  alias get-config='get-config source=running'

Manage the yangcli command aliases

This operation is used to cancel an ongoing confirmed commit.
If the confirmed commit is persistent, the parameter
'persist-id' must be given, and it must match the value of the
'persist' parameter.

This operation is used to cancel an ongoing confirmed commit.
If the confirmed commit is persistent, the parameter
'persist-id' must be given, and it must match the value of the
'persist' parameter.

Stop making toast, if any is being made.
A 'resource-denied' error will be returned
if the toaster service is disabled.

Change the current working directory.

Request graceful termination of a NETCONF session.

Request graceful termination of a NETCONF session.

When a NETCONF server receives a <close-session> request, it will
gracefully close the session.  The server will release any locks
and resources associated with the session and gracefully close any
associated connections.  Any NETCONF requests received after a
'close-session' request will be ignored.

Commit the candidate configuration as the device's new
current configuration

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.

To commit the candidate configuration as the device's new
current configuration, use the <commit> operation.

The 'commit' operation instructs the device to implement the
configuration data contained in the candidate configuration.
If the device is unable to commit all of the changes in the
candidate configuration datastore, then the running
configuration MUST remain unchanged.  If the device does
succeed in committing, the running configuration MUST be
updated with the contents of the candidate configuration.

If the system does not have the :candidate capability, the
'commit' operation is not available.

Connect to a NETCONF server.

Create or replace an entire configuration datastore with the
contents of another complete configuration datastore.

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.

Even if it advertises the :writable-running capability, a device
may choose not to support the <running/> configuration datastore
as the <target> parameter of a <copy-config> operation.  A device
may choose not to support remote-to-remote copy operations, where
both the <source> and <target> parameters use the <url> element.

If the source and target parameters identify the same URL or
configuration datastore, an error MUST be returned with an error-
tag containing invalid-value.

Create some NETCONF config data with the edit-config operation

The command to create a notification subscription. It
takes as argument the name of the notification stream
and filter. Both of those options limit the content of
the subscription. In addition, there are two time-related
parameters, startTime and stopTime, which can be used to
select the time interval of interest to the notification
replay feature.

Delete some NETCONF config data with the edit-config operation

Delete a configuration datastore.

Delete a configuration datastore.  The 'running' configuration
datastore cannot be deleted.

If a NETCONF peer supports the :url capability (Section 8.8), the
'url' element can appear as the <target> parameter.

Revert the candidate configuration to the current
running configuration.

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.

This operation discards any uncommitted changes by resetting
the candidate configuration with the content of the running
configuration.

The 'edit-config' operation loads all or part of a specified
configuration to the specified target configuration.

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.  If
the target configuration does not exist, it will be created.  If a
NETCONF peer supports the :url capability (Section 8.8), the <url>
element can appear instead of the <config> parameter and should
identify a local configuration file.

The device analyzes the source and target configurations and
performs the requested changes.  The target configuration is not
necessarily replaced, as with the <copy-config> message.  Instead,
the target configuration is changed in accordance with the
source's data and requested operations.

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.
This may only be used after an 'if' or 'elif' command
or an error (no matching if command) will occur.

End an 'if' or 'elif' command block, and start a new
command block that must end with an 'end' command.
If no 'if' or 'elif' block is in progress then an error
will occur.

End an 'if' command block or a 'while' command block.
If no block is in progress then an error will occur.

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

When the result of an eval command is saved
to a user variable, it may be altered as follows:

  Convert to string:
   - <data> is a simple type
   - <data> contains 1 node that is a simple type

  Remove the <data> container:
   - <data> contains a single complex element

  Retain the <data> container:
   - <data> contains multiple elements

Usage Examples:

> $x = 5
    x = '5'
> $x = eval '$x + 10'
    x = '15'
> $y = xget /system
    y = data {
	  system { ... }
	}
> $z = eval '//sysname' docroot=$y
    z = 'Linux'
> $w = eval '/system/uname' docroot=$y
    w = uname {
	  sysname 'Linux'
	  ...
	}

Access the notification event log

Fill a value for reuse in a NETCONF PDU or other operation.

Used in an assignment statement to create a variable
for later use:

    $foo = fill --target=/t:foo-con/bar-list 
		--optional 
		--current-value=$bar    

Retrieve running configuration and device state information.

Retrieve running configuration and device state information.

Retrieve all or part of a specified configuration.

Retrieve all or part of a specified configuration.

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 the customization settings for this session

Query the forwarding information base of a router instance
whose name is given as the first parameter 'router-name'. The
second parameter 'destination-address' should be augmented in
order to support destination addresses of all supported
address families. The server returns the route which is
currently used for forwarding datagrams to that destination
address, or an error message, if no such route exists.

This operation is used to retrieve a schema from the
NETCONF server.

Positive Response:
  The NETCONF server returns the requested schema.

Negative Response:
  If requested schema does not exist, the <error-tag> is
  'invalid-value'.

  If more than one schema matches the requested parameters, the
  <error-tag> is 'operation-failed', and <error-app-tag> is
  'data-not-unique'.

Print the yangcli help text

Access the command line history buffer

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 some NETCONF config data with the edit-config operation

Force the termination of a NETCONF session.

Force the termination of a NETCONF session.

When a NETCONF entity receives a <kill-session> request for an
open session, it will abort any operations currently in process,
release any locks and resources associated with the session, and
close any associated connections.

If a NETCONF server receives a <kill-session> request while
processing a confirmed commit (Section 8.4), it must restore the
configuration to its state before the confirmed commit was issued.

Otherwise, the <kill-session> operation does not roll back
configuration or other device state modifications made by the
entity holding the lock.

List some NETCONF info.

Load a module into the server, if it is not already loaded.
Returns the module revision date (or today's date if none),
of the module that was loaded, or an error if not found
or the module found had errors and was not loaded
successfully.  If the module is already loaded, then the
revision date will simply be returned.

The lock operation allows the client to lock the configuration
system of a device.

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

Write a message to the output log if the log-level
is greater or equal to 'debug'.

Write a message to the output log if the log-level
is greater or equal to 'error'.

Write a message to the output log if the log-level
is greater or equal to 'info'.

Write a message to the output log if the log-level
is greater or equal to 'warn'.

Make some toast.
The toastDone notification will be sent when
the toast is finished.
An 'in-use' error will be returned if toast
is already being made.
A 'resource-denied' error will be returned
if the toaster service is disabled.

Merge some NETCONF config data with the edit-config operation

Load a module or other file into the client.
Use the 'load' command to load a module into
the server.

Just returns 'ok'. Used for debugging
or relative performance measurements.

A NETCONF operation that locks parts of the running datastore.

A NETCONF operation that releases a previously acquired
partial-lock.

Print the current working directory.

Quit the yangcli application

Recall the specified command line history
buffer entry into the current command line.

Unlock all the server databases that were
previously locked with the get-locks command.

Remove some NETCONF config data with the edit-config operation

Create some NETCONF config data with the edit-config operation

Restart the server. Does not reload the software image..

Internal command to run a script.

Meta command to save configuration edits.

Sets the server log verbosity level

Set the customization settings for this session.
This is like a merge operation.  Only the values that
are present will be used to overwrite the existing
settings.

Get some NETCONF running config or state data with the get
operation, using an optional subtree filter.

Get some NETCONF config data with the get-config
operation, using an optional subtree filter.

Local show command for yangcli session info.

Shutdown the server.

Start a timer to do simple performance measurements.

Stop a timer and output the delta value.

The unlock operation is used to release a configuration lock,
previously obtained with the 'lock' operation.

The unlock operation is used to release a configuration lock,
previously obtained with the 'lock' operation.

An unlock operation will not succeed if any of the following
conditions are true:

*  the specified lock is not currently active

*  the session issuing the <unlock> operation is not the same
   session that obtained the lock

The server MUST respond with either an <ok> element or an
'rpc-error'.

Delete a specific yangcli command alias.

* Delete one alias 'foo':
  yangcli>  unset foo

Manage the yangcli user variables

Validates the contents of the specified configuration.

Validates the contents of the specified configuration.

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.

Get some NETCONF running config or state data with the get
operation, using an optional XPath filter.

Get some NETCONF config data with the get-config
operation, using an optional XPath filter.