RPC Methods

Invoke a YANG action.
The target of the action must identify a YANG action
statement, which is not a real node in the server data
tree.

Show or set a specific yangcli-pro command alias.

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

  yangcli-pro>  alias

* Show one alias 'foo':

  yangcli-pro>  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-pro>  alias s=show
  yangcli-pro>  alias getfoo='sget-config source=running /top/foo'

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

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

Manage the yangcli-pro command aliases

Run automatic edit testing on the specified object

Backup the current running configuration to a file
on the device.

This is the ber-test rpc. It is supported for a service in the service-list.

Clear 1 or all entries from the YANG module cache.
There are 3 forms of this command:
  cache clear
  cache delete foo
  cache delete=foo revision=2014-05-22

Calling a target function for this session and getting the returned value.

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.

Cancel roll back timer which user provisioned as part of activate command

Cancels a scheduled message.

Cancel a notification subscription for the session,
if this session has an active subscription.  If not,
just return OK.

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

Cancel validation timer which user provisioned as part of activate command

Change the current working directory.

Clear the screen in interactive mode.

Clears the RSVP Security Association (SA) before the
lifetime expires.

RPC to clear the RSVP Hello session to a neighbor.

Command to initialize PM data

Clears RIP routes from the IP routing table and routes
redistributed into the RIP protocol for the specified RIP
instance or for all RIP instances in the current context.

Clears RSVP sessions RPC

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.

Command to query historical PM data.
The device should be able to process an rpc request for 15min data
and a separate request for 24hour data in parallel.

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.

This operation is used to complete an ongoing confirmed
commit procedure. If exclusive write access was granted
for this confirmed commit procedure, then it is removed
if this operation is successfully completed.

If the confirmed commit is persistent, the parameter
'persist-id' MUST be given, and it MUST match the value of
the 'persist' parameter given in the <edit2> operation.
If not confirmed commit procedure is in progress then
the operation fails with an 'operation-failed' error.

This is the complex-ber-test rpc. It is supported for a service in the service-list.

This is the callback notification that the controller invokes on the carrier system.

Enter the configuration mode for the current session.
There must be a current active session or this command
will fail.

Connect to a NETCONF server.

Generates Continuity Check as per Table 4 of RFC 7276.

Generates continuity-check as per RFC7276 Table 4.

Continuity Check RPC operation as per RFC 7276.

Generates Connectivity Verification as per Table 4 in RFC 7276.

Generates continuity-verification as per RFC7276 Table 4.

Rpc used to populate controller parameters in the Data Store
of the RNC.

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

Collects all log data for debugging and place it in a location accessible via ftp/sftp.
This model assumes ASYNC operation, i.e. the command will return after the device accepts the command,
A create-tech-info-notification will be send out later for the result of the operation.
The log-file is cleared at the start of every create-tech-info operation in order to ensure
the up-to-date logs are collected. If a vendor does not support concurrent log collection, the second
create-tech-info command will be rejected.

Initialize the database to default DB

activate the database

copy  running DB to user provided file to a given path

Restore database 

Delete some NETCONF config data with the edit-config operation

Delete some NETCONF config data with the edit-config operation.
Delete all instances of a leaf-list or list object.  At least
one instance must exist or the server will return an error.

Delete the specified backup file on the device.

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.

Delete one or more files in the specified directory.

This RPC allows a subscriber to delete a subscription that
was previously created by that same subscriber using the
'establish-subscription' RPC.

If an error occurs, the server replies with an 'rpc-error'
where the 'error-info' field MAY contain a
'delete-subscription-error-info' structure.

Access a device configuration

Controls access to the saved devices file

This RPC is send by the client when it stops using a
particular exi-schema-id.

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.

Edit data in an NMDA datastore.

If an error condition occurs such that an error severity
<rpc-error> element is generated, the server will stop
processing the <edit-data> operation and restore the
specified configuration to its complete state at
the start of this <edit-data> operation.

Edit NETCONF datastore contents.
All operations requested in the yang-patch edit list
are applied, or the target datastore is left unchanged.

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.

Use 'enable' to enter enable mode for yp-shell.
Use 'enable password' to configure the password.
Use 'enable no-password' to remove the password.

If a password has been set, then it will be required to
enter enable mode.

Use <enable-password> to config the password in
the config mode for yp-shell.

Request the use of specificied schema in EXI message
encoding.  This request is sent by the client to the
server. If the server is able to transition into using
the schema, it assigns it a unique EXI integer
identifier.  This identifier is to be used in the EXI
header as schema identifier.

The server may start using the identifier as soon as it
enqueus the response. The client may start using the
identifier as soon as it sees this RPC complete.

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

This RPC allows a subscriber to create (and possibly
negotiate) a subscription on its own behalf.  If successful,
the subscription remains in effect for the duration of the
subscriber's association with the publisher or until the
subscription is terminated.  If an error occurs or the
publisher cannot meet the terms of a subscription, an RPC
error is returned, and the subscription is not created.
In that case, the RPC reply's 'error-info' MAY include
suggested parameter settings that would have a higher
likelihood of succeeding in a subsequent
'establish-subscription' request.

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

Example external command

Exit the currrent configuration level for the current session.
There must be a current active session or this command
will fail. The current session must also be in the
configuration mode. Any pending edits will be applied
if the edit-config-mode is set to 'level'.

The server resets all datastores to their factory
default contents and any nonvolatile storage back to
factory condition, deleting all dynamically
generated files, including those containing keys,
certificates, logs, and other temporary files.

Depending on the factory default configuration, after
being reset, the device may become unreachable on the
network.

The server resets all datastores to their factory
default content and any non-volatile storage back to
factory condition, deleting all dynamically generated
files, including those containing keys, certificates,
logs, and other temporary files.

Depending on the factory default configuration, after
being reset, the device may become unreachable on the
network.

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

Fpga data update

Retrieve running configuration and device state information.

Retrieve running configuration and device state information.

Returns the set of identity values that are supported for
a specific data node instance.  The server will indicate
if all instances of the specified data node accept the
same value set.

The server will return an error with an
'invalid-value' error-tag if the target parameter
referenced an invalid instance.

The server MAY support this operation for operational
data (i.e. config false). If not, then an error with an
'operation-not-supported' error-tag will be returned
by the server if the target parameter does not identify
a data node in the configuration datastore

Returns the set of leafref values that are supported for
a specific data node instance.  The server will indicate
if all instances of the specified data node accept the
same value set.

The server will return an error with an
'invalid-value' error-tag if the target parameter
referenced an invalid instance.

The server MAY support this operation for operational
data (i.e. config false). If not, then an error with an
'operation-not-supported' error-tag will be returned
by the server if the target parameter does not identify
a data node in the configuration datastore

This RPC enables a device, as identified by the RESTCONF
username, to obtain bootstrapping data that has been made
available for it.

Retrieve multiple list entries at a time

Retrieve the NETCONF or RESTCONF capabilities for
the specified sessions.

The session-name leaf-list is considered to be
a logical OR expression. A 'session-output' list entry
will be returned for each matching session name
that corresponds to a session for which the capabilities
are available.

Retrieve all or part of a specified configuration.

Retrieve all or part of a specified configuration.

Retrieve data from an NMDA datastore.  The content returned
by get-data must satisfy all filters, i.e., the filter
criteria are logically ANDed.

Any ancestor nodes (including list keys) of nodes selected by
the filters are included in the response.

The 'with-origin' parameter is only valid for an operational
datastore.  If 'with-origin' is used with an invalid
datastore, then the server MUST return an <rpc-error> element
with an <error-tag> value of 'invalid-value'.

The 'with-defaults' parameter only applies to the operational
datastore if the NETCONF :with-defaults and
:with-operational-defaults capabilities are both advertised.
If the 'with-defaults' parameter is present in a request for
which it is not supported, then the server MUST return an
<rpc-error> element with an <error-tag> value of
'invalid-value'.

Retrieve raw events from the event log for 1 or more
sessions. The input filters are combined to form
a logical AND expression. All filters that are present
must pass for an event to be included in the response.

The session-name leaf-list is considered to be
a logical OR expression. A 'session-output' list entry
will be returned for each matching session name
that corresponds to the event log that search results
were found.

All invalid values are considered to be
false matches and not errors.

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 list of configured module-tags.
The --module-tagmap parameter is used to configure
a module-tag.

Get the customization settings for this session

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

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

When the schema is available on the device this operation is
used to return it via NETCONF.  If requested schema does not
exist, the <error-tag> is 'invalid-value'.  If requested schema
is not unique, the <error-tag> is  'operation-failed' and the
<error-app-tag> is 'data-not-unique'.

Get service function description information.

Get current service function monitoring information.

Retrieve the support-save info from the server.
Save the output to an XML file and attach to
a bug report. Send with a complete description
of the issue to support@yumaworks.com.

yangcli-pro Example:

session1> @server-issue.xml = get-support-save

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.

If the yumaworks-getbulk YANG module is not supported by
the server then this command will not be attempted.

If the program is in interactive mode, then after each
retrieval, the user will be prompted to continue or quit
the walk. In batch mode the entries will be displayed
until the walk terminates.

The server will wait the normal 'timeout' period after
each request. It will display each response and check it
for 'last-keys' data.  If present, these values will
be used for the 'last-keys' parameter in the next request.
If not present, then the walk will end.

The walk will be done on the YANG list specified by the
the 'list-target' parameter. Each retrieval will request
1 or more entries, based on the 'count' parameter. The
data returned can be filtered according to the 'content',
'depth', 'with-defaults', and 'list-test' parameters,
which as passed to the <get-bulk> operation each time.

Retrieve NETCONF datastore information

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.

Print the yangcli-pro 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

Invoke a YANG action for 1 or more sessions.

The session-name leaf-list is considered to be
a logical OR expression. A 'session-output' list entry
will be returned for each matching session name
that corresponds to a session for which the action
was attempted.

Invoke an RPC operation for 1 or more sessions.

The session-name leaf-list is considered to be
a logical OR expression. A 'session-output' list entry
will be returned for each matching session name
that corresponds to a session for which the RPC operation
was attempted.

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.

This RPC allows an operator to delete a dynamic subscription
without restrictions on the originating subscriber or
underlying transport session.

If an error occurs, the server replies with an 'rpc-error'
where the 'error-info' field MAY contain a
'delete-subscription-error-info' structure.

This command is used to allow user to find an entity on the NE,
The specified entity will have LED blinking.
The equipmentLedOn alarm will be raised and cleared for the indication

Triggers a link state update for the specific interface.

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.

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.

Load a SIL bundle into the server, if it is not already loaded.

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.

This RPC allows a subscriber to modify a dynamic
subscription's parameters.  If successful, the changed
subscription parameters remain in effect for the duration of
the subscription, until the subscription is again modified, or
until the subscription is terminated.  In the case of an error
or an inability to meet the modified parameters, the
subscription is not modified and the original subscription
parameters remain in effect.  In that case, the RPC error MAY
include 'error-info' suggested parameter hints that would have
a high likelihood of succeeding in a subsequent
'modify-subscription' request.  A successful
'modify-subscription' will return a suspended subscription to
the 'active' state.

To add a nexthop to a RIB.
Inputs parameters:
  1. rib-name
  2. nexthop
Actions:
  Add the nexthop to the RIB
Outputs:
  1. Operation result:
     true  - success
     false - failed
  2. nexthop identifier

To delete a nexthop from a RIB

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

Save the running datastore to the startup datastore.

ODU SNCP Protection Switch RPC with synchronous implementation

A NETCONF operation that locks parts of the running datastore.

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

Path discovery RPC operation as per RFC 7276.

Print the current working directory.

Quit the yangcli-pro application

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

Use the unit test-suite automatic test recording feature.
Only one test can be recorded at a time. Either cancel
or finish a test in progress in order to start recording
a new test.

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

Remove some NETCONF config data with the edit-config operation

Remove some NETCONF config data with the edit-config operation.
Remove all instances of a leaf-list or list object.

Create some NETCONF config data with the edit-config operation

The report operation is used by a Measurement Agent to
submit measurement results produced by Measurement Tasks to
a Collector.

This RPC enables a device, as identified by the RESTCONF
username, to report its bootstrapping progress to the
bootstrap server.  This RPC is expected to be used when
the device obtains onboarding-information from a trusted
bootstrap server.

Restart a resource with warm/cold option. If no resource is provided or only the device name is provided, then the device itself will be restarted.
Note that resources on the device will not be restartable

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