netconfcentral logo

RPC Methods

cancel-toast

Summary

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

Details

Node ID /cancel-toast
Module toaster
Version 2009-11-20
Config 1
Mandatory 0
Children input output
Source toaster line 160

cd

Summary

Name cd
  
 
Change the current working directory.

Details

Node ID /cd
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 491

close-session

Summary

Name close-session
  
 
Request graceful termination of a NETCONF session.

Details

Node ID /close-session
Module ietf-netconf
Version 2010-05-18
Reference RFC XXXX, #X#<close-session>#
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 509

close-session

Summary

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

Details

Node ID /close-session
Module yuma-netconf
Version 2010-05-24
Reference RFC 4741, section 7.8
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 923

commit

Summary

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

Details

Node ID /commit
Module ietf-netconf
Version 2010-05-18
Reference RFC XXXX, #X#<commit>#
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 532

commit

Summary

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

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.

Details

Node ID /commit
Module yuma-netconf
Version 2010-05-24
Reference RFC 4741, section 8.3.4.1
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 965

connect

Summary

Name connect
  
 
Connect to a NETCONF server.

Details

Node ID /connect
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 504

copy-config

Summary

Name copy-config
  
 
Create or replace an entire configuration datastore with the
contents of another complete configuration datastore.

Details

Node ID /copy-config
Module ietf-netconf
Version 2010-05-18
Reference RFC XXXX, #X#<copy-config>#
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 323

copy-config

Summary

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

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.

Details

Node ID /copy-config
Module yuma-netconf
Version 2010-05-24
Reference RFC 4741, section 7.3
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 691

create

Summary

Name create
  
 
Create some NETCONF config data with the edit-config operation

Details

Node ID /create
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 525

create-subscription

Summary

Name create-subscription
  
 
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.

Details

Node ID /create-subscription
Module notifications
Version 2008-07-14
Config 1
Mandatory 0
Children input output
Source notifications line 33

delete

Summary

Name delete
  
 
Delete some NETCONF config data with the edit-config operation

Details

Node ID /delete
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 534

delete-config

Summary

Name delete-config
  
 
Delete a configuration datastore.

Details

Node ID /delete-config
Module ietf-netconf
Version 2010-05-18
Reference RFC XXXX, #X#<delete-config>#
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 393

delete-config

Summary

Name delete-config
  
 
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.

Details

Node ID /delete-config
Module yuma-netconf
Version 2010-05-24
Reference RFC 4741, section 7.4
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 776

discard-changes

Summary

Name discard-changes
  
 
Revert the candidate configuration to the current 
running configuration.

Details

Node ID /discard-changes
Module ietf-netconf
Version 2010-05-18
Reference RFC XXXX, #X#<discard-changes>#
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 560

discard-changes

Summary

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

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

Details

Node ID /discard-changes
Module yuma-netconf
Version 2010-05-24
Reference RFC 4741, section 8.3.4.2
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 1009

edit-config

Summary

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

Details

Node ID /edit-config
Module ietf-netconf
Version 2010-05-18
Reference RFC XXXX, #X#<edit-config>#
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 246

edit-config

Summary

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

Details

Node ID /edit-config
Module yuma-netconf
Version 2010-05-24
Reference RFC 4741, section 7.2
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 614

elif

Summary

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

Details

Node ID /elif
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 549

else

Summary

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

Details

Node ID /else
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 564

end

Summary

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

Details

Node ID /end
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 573

eval

Summary

Name 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

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

Details

Node ID /eval
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 580

eventlog

Summary

Name eventlog
  
 
Access the notification event log

Details

Node ID /eventlog
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 646

fill

Summary

Name fill
  
 
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    

Details

Node ID /fill
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 687

get

Summary

Name get
  
 
Retrieve running configuration and device state information.

Details

Node ID /get
Module ietf-netconf
Version 2010-05-18
Reference RFC XXXX, #X#<get>#
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 482

get

Summary

Name get
  
 
Retrieve running configuration and device state information.

Details

Node ID /get
Module yuma-netconf
Version 2010-05-24
Reference RFC 4741, section 7.7
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 879

get-config

Summary

Name get-config
  
 
Retrieve all or part of a specified configuration.

Details

Node ID /get-config
Module ietf-netconf
Version 2010-05-18
Reference RFC XXXX, #X#<get-config>#
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 195

get-config

Summary

Name get-config
  
 
Retrieve all or part of a specified configuration.

Details

Node ID /get-config
Module yuma-netconf
Version 2010-05-24
Reference RFC 4741, section 7.2
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 562

get-locks

Summary

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

Details

Node ID /get-locks
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 719

get-my-session

Summary

Name get-my-session
  
 
Get the customization settings for this session

Details

Node ID /get-my-session
Module yuma-mysession
Version 2010-05-10
Config 1
Mandatory 0
Children output input
Source yuma-mysession line 50

get-schema

Summary

Name get-schema
  
 
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'.

Details

Node ID /get-schema
Module ietf-netconf-monitoring
Version 2010-06-01
Config 1
Mandatory 0
Children input output
Source ietf-netconf-monitoring line 522

help

Summary

Name help
  
 
Print the yangcli help text

Details

Node ID /help
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 759

history

Summary

Name history
  
 
Access the command line history buffer

Details

Node ID /history
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 791

if

Summary

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

Details

Node ID /if
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 835

insert

Summary

Name insert
  
 
Insert some NETCONF config data with the edit-config operation

Details

Node ID /insert
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 848

kill-session

Summary

Name kill-session
  
 
Force the termination of a NETCONF session.

Details

Node ID /kill-session
Module ietf-netconf
Version 2010-05-18
Reference RFC XXXX, #X#<kill-session>#
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 516

kill-session

Summary

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

Details

Node ID /kill-session
Module yuma-netconf
Version 2010-05-24
Reference RFC 4741, section 7.9
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 937

list

Summary

Name list
  
 
List some NETCONF info.

Details

Node ID /list
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 905

load

Summary

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

Details

Node ID /load
Module yuma-system
Version 2010-05-24
Config 1
Mandatory 0
Children input output
Source yuma-system line 400

lock

Summary

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

Details

Node ID /lock
Module ietf-netconf
Version 2010-05-18
Reference RFC XXXX, #X#<lock>#
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 420

lock

Summary

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

Details

Node ID /lock
Module yuma-netconf
Version 2010-05-24
Reference RFC 4741, section 7.5
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 805

log-debug

Summary

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

Details

Node ID /log-debug
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 999

log-error

Summary

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

Details

Node ID /log-error
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 954

log-info

Summary

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

Details

Node ID /log-info
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 984

log-warn

Summary

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

Details

Node ID /log-warn
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 969

make-toast

Summary

Name make-toast
  
 
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.

Details

Node ID /make-toast
Module toaster
Version 2009-11-20
Config 1
Mandatory 0
Children input output
Source toaster line 122

merge

Summary

Name merge
  
 
Merge some NETCONF config data with the edit-config operation

Details

Node ID /merge
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 1014

mgrload

Summary

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

Details

Node ID /mgrload
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 1023

no-op

Summary

Name no-op
  
 
Just returns 'ok'. Used for debugging
or relative performance measurements.

Details

Node ID /no-op
Module yuma-system
Version 2010-05-24
Config 1
Mandatory 0
Children input output
Source yuma-system line 448

partial-lock

Summary

Name partial-lock
  
 
A NETCONF operation that locks parts of the running datastore.

Details

Node ID /partial-lock
Module ietf-netconf-partial-lock
Version 2009-10-19
Config 1
Mandatory 0
Children input output
Source ietf-netconf-partial-lock line 37

partial-unlock

Summary

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

Details

Node ID /partial-unlock
Module ietf-netconf-partial-lock
Version 2009-10-19
Config 1
Mandatory 0
Children input output
Source ietf-netconf-partial-lock line 69

pwd

Summary

Name pwd
  
 
Print the current working directory.

Details

Node ID /pwd
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 1045

quit

Summary

Name quit
  
 
Quit the yangcli application

Details

Node ID /quit
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 1058

recall

Summary

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

Details

Node ID /recall
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 1062

release-locks

Summary

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

Details

Node ID /release-locks
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 1080

replace

Summary

Name replace
  
 
Create some NETCONF config data with the edit-config operation

Details

Node ID /replace
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 1049

restart

Summary

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

Details

Node ID /restart
Module yuma-system
Version 2010-05-24
Config 1
Mandatory 0
Children input output
Source yuma-system line 436

run

Summary

Name run
  
 
Internal command to run a script.

Details

Node ID /run
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 1086

save

Summary

Name save
  
 
Meta command to save configuration edits.

Details

Node ID /save
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 1140

set-log-level

Summary

Name set-log-level
  
 
Sets the server log verbosity level

Details

Node ID /set-log-level
Module yuma-system
Version 2010-05-24
Config 1
Mandatory 0
Children input output
Source yuma-system line 142

set-my-session

Summary

Name set-my-session
  
 
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.

Details

Node ID /set-my-session
Module yuma-mysession
Version 2010-05-10
Config 1
Mandatory 0
Children input output
Source yuma-mysession line 58

sget

Summary

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

Details

Node ID /sget
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 1144

sget-config

Summary

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

Details

Node ID /sget-config
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 1161

show

Summary

Name show
  
 
Local show command for yangcli info.

Details

Node ID /show
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 1208

shutdown

Summary

Name shutdown
  
 
Shutdown the server.

Details

Node ID /shutdown
Module yuma-system
Version 2010-05-24
Config 1
Mandatory 0
Children input output
Source yuma-system line 442

unlock

Summary

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

Details

Node ID /unlock
Module ietf-netconf
Version 2010-05-18
Reference RFC XXXX, #X#<unlock>#
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 451

unlock

Summary

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

Details

Node ID /unlock
Module yuma-netconf
Version 2010-05-24
Reference RFC 4741, section 7.6
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 838

validate

Summary

Name validate
  
 
Validates the contents of the specified configuration.

Details

Node ID /validate
Module ietf-netconf
Version 2010-05-18
Reference RFC XXXX, #X#<validate>#
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 570

validate

Summary

Name validate
  
 
Validates the contents of the specified configuration.

Details

Node ID /validate
Module yuma-netconf
Version 2010-05-24
Reference RFC 4741, section 8.6.4.1
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 1025

while

Summary

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

Details

Node ID /while
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 1269

xget

Summary

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

Details

Node ID /xget
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 1291

xget-config

Summary

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

Details

Node ID /xget-config
Module yangcli
Version 2010-04-16
Config 1
Mandatory 0
Children input output
Source yangcli line 1307