netconfcentral logo

RPC Methods

action

Summary

Name action
  
 
YANG 1.1 action.  This node is specially parsed.
It does not follow any YANG-supportable schema.

The action container should have 1 subtree starting
with a top-level data node.  There should be 1 subtree
that matches an action-stmt definition.

Details

Node ID /action
Module yang-attributes
Version 2016-01-06
Config 1
Mandatory 0
Children input output
Source yang-attributes line 65

action

Summary

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

Details

Node ID /action
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 1757

alias

Summary

Name alias
  
 
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'

Details

Node ID /alias
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 1773

aliases

Summary

Name aliases
  
 
Manage the yangcli-pro command aliases

Details

Node ID /aliases
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 1824

auto-test

Summary

Name auto-test
  
 
Run automatic edit testing on the specified object

Details

Node ID /auto-test
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 1866

backup

Summary

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

Details

Node ID /backup
Module yumaworks-system
Version 2017-12-22
Config 1
Mandatory 0
Children input output
Source yumaworks-system line 166

cache

Summary

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

Details

Node ID /cache
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 1907

call-appropriate-nsf

Summary

Name call-appropriate-nsf
  
 
We can acquire appropriate NSF that we want
If we give type of NSF that we want to use,
we acquire the location information of NSF

Details

Node ID /call-appropriate-nsf
Module ietf-i2nsf-capability
Version 2017-10-30
Config 1
Mandatory 0
Children input output
Source ietf-i2nsf-capability line 1580

cancel-commit

Summary

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

Details

Node ID /cancel-commit
Module yuma-netconf
Version 2015-04-30
Reference RFC 6241, section 8.4.4.1.
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 1294

cancel-commit

Summary

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

Details

Node ID /cancel-commit
Module ietf-netconf
Version 2011-06-01
Reference RFC 6241, Section 8.4.4.1
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 860

cancel-schedule

Summary

Name cancel-schedule
  
 
Cancels a scheduled message.

Details

Node ID /cancel-schedule
Module ietf-netconf-time
Version 2016-01-26
Reference RFC 7758: Time Capability in NETCONF
Config 1
Mandatory 0
Children input output
Source ietf-netconf-time line 330

cancel-subscription

Summary

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

Details

Node ID /cancel-subscription
Module yumaworks-system
Version 2017-12-22
Config 1
Mandatory 0
Children input output
Source yumaworks-system line 226

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 167

cd

Summary

Name cd
  
 
Change the current working directory.

Details

Node ID /cd
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 1943

clean-client-statistics

Summary

Name clean-client-statistics
  
 
Clean client packet statistics

Details

Node ID /clean-client-statistics
Module ietf-dhcp
Version 2017-03-02
Config 1
Mandatory 0
Children input output
Source ietf-dhcp line 520

clean-relay-statistics

Summary

Name clean-relay-statistics
  
 
Clean relay packet statistics

Details

Node ID /clean-relay-statistics
Module ietf-dhcp
Version 2017-03-02
Config 1
Mandatory 0
Children input output
Source ietf-dhcp line 495

clean-server-statistics

Summary

Name clean-server-statistics
  
 
Clean server packet statistics

Details

Node ID /clean-server-statistics
Module ietf-dhcp
Version 2017-03-02
Config 1
Mandatory 0
Children input output
Source ietf-dhcp line 471

clear

Summary

Name clear
  
 
Clear the screen in interactive mode.

Details

Node ID /clear
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 1956

clear-adjacency

Summary

Name clear-adjacency
  
 
This RPC request clears a particular
set of ISIS adjacencies. If the operation
fails for ISIS internal reason, then
error-tag and error-app-tag should be set
to a meaningful value.

Details

Node ID /clear-adjacency
Module ietf-isis
Version 2017-11-20
Config 1
Mandatory 0
Children input output
Source ietf-isis line 3049

clear-database

Summary

Name clear-database
  
 
This RPC request clears a particular
ISIS database. If the operation
fails for ISIS internal reason, then
error-tag and error-app-tag should be set
to a meaningful value.

Details

Node ID /clear-database
Module ietf-isis
Version 2017-11-20
Config 1
Mandatory 0
Children input output
Source ietf-isis line 3098

clear-database

Summary

Name clear-database
  
 
This RPC request clears a particular
OSPF database. If the operation
fails for OSPF internal reason, then
error-tag and error-app-tag should be set
to a meaningful value.

Details

Node ID /clear-database
Module ietf-ospf
Version 2017-10-30
Config 1
Mandatory 0
Children input output
Source ietf-ospf line 3488

clear-igmp-groups

Summary

Name clear-igmp-groups
  
 
Clears the specified IGMP cache entries.

Details

Node ID /clear-igmp-groups
Module ietf-igmp-mld
Version 2017-10-20
Config 1
Mandatory 0
Children input output
Source ietf-igmp-mld line 1058

clear-igmp-snooping-groups

Summary

Name clear-igmp-snooping-groups
  
 
Clears the specified IGMP Snooping cache tables.

Details

Node ID /clear-igmp-snooping-groups
Module ietf-igmp-mld-snooping
Version 2017-10-25
Config 1
Mandatory 0
Children input output
Source ietf-igmp-mld-snooping line 1241

clear-mld-groups

Summary

Name clear-mld-groups
  
 
Clears the specified MLD cache entires.

Details

Node ID /clear-mld-groups
Module ietf-igmp-mld
Version 2017-10-20
Config 1
Mandatory 0
Children input output
Source ietf-igmp-mld line 1088

clear-mld-snooping-groups

Summary

Name clear-mld-snooping-groups
  
 
Clears the specified MLD Snooping cache tables.

Details

Node ID /clear-mld-snooping-groups
Module ietf-igmp-mld-snooping
Version 2017-10-25
Config 1
Mandatory 0
Children input output
Source ietf-igmp-mld-snooping line 1273

clear-neighbor

Summary

Name clear-neighbor
  
 
This RPC request clears a particular
set of OSPF neighbors. If the operation
fails for OSPF internal reason, then
error-tag and error-app-tag should be set
to a meaningful value.

Details

Node ID /clear-neighbor
Module ietf-ospf
Version 2017-10-30
Config 1
Mandatory 0
Children input output
Source ietf-ospf line 3449

clear-rip-route

Summary

Name clear-rip-route
  
 
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.

Details

Node ID /clear-rip-route
Module ietf-rip
Version 2017-12-05
Config 1
Mandatory 0
Children input output
Source ietf-rip line 1108

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 2015-04-30
Reference RFC 4741, section 7.8
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 1162

close-session

Summary

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

Details

Node ID /close-session
Module ietf-netconf
Version 2011-06-01
Reference RFC 6241, Section 7.8
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 763

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 2015-04-30
Reference RFC 4741, section 8.3.4.1
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 1205

commit

Summary

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

Details

Node ID /commit
Module ietf-netconf
Version 2011-06-01
Reference RFC 6241, Section 8.3.4.1
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 787

compare

Summary

Name compare
  
 
NMDA compare operation.

Details

Node ID /compare
Module ietf-nmda-compare
Version 2017-10-30
Config 1
Mandatory 0
Children input output
Source ietf-nmda-compare line 54

complete-commit

Summary

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

Details

Node ID /complete-commit
Module ietf-netconf-ex
Version 2014-04-21
Reference RFC 6241, Section 8.4.5.1
Config 1
Mandatory 0
Children input output
Source ietf-netconf-ex line 652

compress-alarms

Summary

Name compress-alarms
  
 
This operation requests the server to compress entries in the
alarm list by removing all but the latest state change for all
alarms.  Conditions in the input are logically ANDed.  If no
input condition is given, all alarms are compressed.

Details

Node ID /compress-alarms
Module ietf-alarms
Version 2017-10-30
Config 1
Mandatory 0
Children input output
Source ietf-alarms line 965

config

Summary

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

Details

Node ID /config
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 1960

connect

Summary

Name connect
  
 
Connect to a NETCONF server.

Details

Node ID /connect
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 1977

continuity-check

Summary

Name continuity-check
  
 
Generates continuity-check as per RFC7276 Table 4.

Details

Node ID /continuity-check
Module ietf-connection-oriented-oam
Version 2017-06-01
Config 1
Mandatory 0
Children input output
Source ietf-connection-oriented-oam line 819

continuity-check

Summary

Name continuity-check
  
 
Continuity-check RPC operation as per RFC7276.

Details

Node ID /continuity-check
Module ietf-connectionless-oam-methods
Version 2017-09-06
Config 1
Mandatory 0
Children input output
Source ietf-connectionless-oam-methods line 155

continuity-verification

Summary

Name continuity-verification
  
 
Generates continuity-verification as per RFC7276 Table 4.

Details

Node ID /continuity-verification
Module ietf-connection-oriented-oam
Version 2017-06-01
Config 1
Mandatory 0
Children input output
Source ietf-connection-oriented-oam line 912

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 2011-06-01
Reference RFC 6241, Section 7.3
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 537

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 2015-04-30
Reference RFC 4741, section 7.3
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 927

create

Summary

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

Details

Node ID /create
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2003

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 2013-03-15
Config 1
Mandatory 0
Children input output
Source notifications line 37

delete

Summary

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

Details

Node ID /delete
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2012

delete-all

Summary

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

Details

Node ID /delete-all
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2041

delete-backup

Summary

Name delete-backup
  
 
Delete the specified backup file on the device.

Details

Node ID /delete-backup
Module yumaworks-system
Version 2017-12-22
Config 1
Mandatory 0
Children input output
Source yumaworks-system line 192

delete-config

Summary

Name delete-config
  
 
Delete a configuration datastore.

Details

Node ID /delete-config
Module ietf-netconf
Version 2011-06-01
Reference RFC 6241, Section 7.4
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 625

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 2015-04-30
Reference RFC 4741, section 7.4
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 1014

delete-subscription

Summary

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

Details

Node ID /delete-subscription
Module ietf-subscribed-notifications
Version 2017-10-27
Config 1
Mandatory 0
Children input output
Source ietf-subscribed-notifications line 683

device-cfg

Summary

Name device-cfg
  
 
Access a device configuration

Details

Node ID /device-cfg
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2799

devices-cfg

Summary

Name devices-cfg
  
 
Controls access to the saved devices file

Details

Node ID /devices-cfg
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2833

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 2015-04-30
Reference RFC 4741, section 8.3.4.2
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 1279

discard-changes

Summary

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

Details

Node ID /discard-changes
Module ietf-netconf
Version 2011-06-01
Reference RFC 6241, Section 8.3.4.2
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 851

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 2011-06-01
Reference RFC 6241, Section 7.2
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 421

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 2015-04-30
Reference RFC 4741, section 7.2
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 847

edit-data

Summary

Name edit-data
  
 
Edit data in an NMDA datastore.

Details

Node ID /edit-data
Module ietf-netconf-datastores
Version 2017-08-24
Config 1
Mandatory 0
Children input output
Source ietf-netconf-datastores line 162

edit2

Summary

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

Details

Node ID /edit2
Module ietf-netconf-ex
Version 2014-04-21
Config 1
Mandatory 0
Children input output
Source ietf-netconf-ex line 401

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-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2067

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-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2084

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-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2096

establish-subscription

Summary

Name establish-subscription
  
 
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. In case an error (as indicated by
subscription-result) is returned, the subscription is not
created.  In that case, the RPC reply MAY include suggested
parameter settings that would have a higher likelihood of
succeeding in a subsequent establish-subscription request.

Details

Node ID /establish-subscription
Module ietf-subscribed-notifications
Version 2017-10-27
Config 1
Mandatory 0
Children input output
Source ietf-subscribed-notifications line 601

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-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2103

eventlog

Summary

Name eventlog
  
 
Access the notification event log

Details

Node ID /eventlog
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2169

exit

Summary

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

Details

Node ID /exit
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2210

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

Details

Node ID /fill
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2219

get

Summary

Name get
  
 
Retrieve running configuration and device state information.

Details

Node ID /get
Module yuma-netconf
Version 2015-04-30
Reference RFC 4741, section 7.7
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 1118

get

Summary

Name get
  
 
Retrieve running configuration and device state information.

Details

Node ID /get
Module ietf-netconf
Version 2011-06-01
Reference RFC 6241, Section 7.7
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 737

get-bootstrapping-data

Summary

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

Details

Node ID /get-bootstrapping-data
Module ietf-zerotouch-bootstrap-server
Version 2017-10-19
Config 1
Mandatory 0
Children input output
Source ietf-zerotouch-bootstrap-server line 65

get-bulk

Summary

Name get-bulk
  
 
Retrieve multiple list entries at a time

Details

Node ID /get-bulk
Module yumaworks-getbulk
Version 2016-05-10
Config 1
Mandatory 0
Children input output
Source yumaworks-getbulk line 105

get-config

Summary

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

Details

Node ID /get-config
Module yuma-netconf
Version 2015-04-30
Reference RFC 4741, section 7.2
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 795

get-config

Summary

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

Details

Node ID /get-config
Module ietf-netconf
Version 2011-06-01
Reference RFC 6241, Section 7.1
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 366

get-data

Summary

Name get-data
  
 
Retrieve data from an NMDA datastore.

Details

Node ID /get-data
Module ietf-netconf-datastores
Version 2017-08-24
Config 1
Mandatory 0
Children input output
Source ietf-netconf-datastores line 85

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-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2249

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 2013-10-05
Config 1
Mandatory 0
Children output input
Source yuma-mysession line 74

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-10-04
Config 1
Mandatory 0
Children input output
Source ietf-netconf-monitoring line 510

get-support-save

Summary

Name get-support-save
  
 
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

Details

Node ID /get-support-save
Module yumaworks-support-save
Version 2017-07-27
Config 1
Mandatory 0
Children output input
Source yumaworks-support-save line 90

get2

Summary

Name get2
  
 
Retrieve NETCONF datastore information

Details

Node ID /get2
Module ietf-netconf-ex
Version 2014-04-21
Config 1
Mandatory 0
Children input output
Source ietf-netconf-ex line 225

globals-rpc

Summary

Name globals-rpc
  
 
Execution data for TE global.

Details

Node ID /globals-rpc
Module ietf-te
Version 2017-10-29
Config 1
Mandatory 0
Children input output
Source ietf-te line 1647

group

Summary

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

Details

Node ID /group
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2289

help

Summary

Name help
  
 
Print the yangcli-pro help text

Details

Node ID /help
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2361

history

Summary

Name history
  
 
Access the command line history buffer

Details

Node ID /history
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2396

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-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2440

insert

Summary

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

Details

Node ID /insert
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2453

interfaces-rpc

Summary

Name interfaces-rpc
  
 
Execution data for TE interfaces.

Details

Node ID /interfaces-rpc
Module ietf-te
Version 2017-10-29
Config 1
Mandatory 0
Children input output
Source ietf-te line 1653

interfaces-rpc

Summary

Name interfaces-rpc
  
 
Execution data for TE interfaces.

Details

Node ID /interfaces-rpc
Module ietf-te-device
Version 2017-10-29
Config 1
Mandatory 0
Children input output
Source ietf-te-device line 638

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 2015-04-30
Reference RFC 4741, section 7.9
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 1176

kill-session

Summary

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

Details

Node ID /kill-session
Module ietf-netconf
Version 2011-06-01
Reference RFC 6241, Section 7.9
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 770

kill-subscription

Summary

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

Details

Node ID /kill-subscription
Module ietf-subscribed-notifications
Version 2017-10-27
Config 1
Mandatory 0
Children input output
Source ietf-subscribed-notifications line 709

list

Summary

Name list
  
 
List some NETCONF info.

Details

Node ID /list
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2510

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 yumaworks-system
Version 2017-12-22
Config 1
Mandatory 0
Children input output
Source yumaworks-system line 415

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 2013-07-15
Config 1
Mandatory 0
Children input output
Source yuma-system line 567

load-bundle

Summary

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

Details

Node ID /load-bundle
Module yumaworks-system
Version 2017-12-22
Config 1
Mandatory 0
Children input output
Source yumaworks-system line 304

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 2011-06-01
Reference RFC 6241, Section 7.5
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 659

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 2015-04-30
Reference RFC 4741, section 7.5
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 1044

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-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2559

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-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2589

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-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2574

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-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2604

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 129

merge

Summary

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

Details

Node ID /merge
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2619

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-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2628

modify-subscription

Summary

Name modify-subscription
  
 
This RPC allows a subscriber to modify a subscription that was
previously created using establish-subscription.  If successful,
the changed subscription remains in effect for the duration of
the subscriber's association with the publisher, or until the
subscription is again modified or terminated.  In case an error
is returned (as indicated by subscription-result), the
subscription is not modified and the original subscription
parameters remain in effect.  In that case, the rpc error
response MAY include suggested parameter hints that would have
a high likelihood of succeeding in a subsequent
modify-subscription request.

Details

Node ID /modify-subscription
Module ietf-subscribed-notifications
Version 2017-10-27
Config 1
Mandatory 0
Children input output
Source ietf-subscribed-notifications line 657

mount

Summary

Name mount
  
 
This RPC allows an application or administrative user to
perform a mount operation.  If successful, it will result in
the creation of a new mountpoint.

Details

Node ID /mount
Module ietf-mount
Version 2017-03-30
Config 1
Mandatory 0
Children input output
Source ietf-mount line 267

mpls-ldp-clear-hello-adjacency

Summary

Name mpls-ldp-clear-hello-adjacency
  
 
Clears the hello adjacency

Details

Node ID /mpls-ldp-clear-hello-adjacency
Module ietf-mpls-ldp
Version 2017-10-29
Config 1
Mandatory 0
Children input output
Source ietf-mpls-ldp line 1184

mpls-ldp-clear-peer

Summary

Name mpls-ldp-clear-peer
  
 
Clears the session to the peer.

Details

Node ID /mpls-ldp-clear-peer
Module ietf-mpls-ldp
Version 2017-10-29
Config 1
Mandatory 0
Children input output
Source ietf-mpls-ldp line 1168

mpls-ldp-clear-peer-statistics

Summary

Name mpls-ldp-clear-peer-statistics
  
 
Clears protocol statistics (e.g. sent and received
counters).

Details

Node ID /mpls-ldp-clear-peer-statistics
Module ietf-mpls-ldp
Version 2017-10-29
Config 1
Mandatory 0
Children input output
Source ietf-mpls-ldp line 1239

msdp-clear-peer

Summary

Name msdp-clear-peer
  
 
Clears the session to the peer.

Details

Node ID /msdp-clear-peer
Module ietf-msdp
Version 2017-08-30
Config 1
Mandatory 0
Children input output
Source ietf-msdp line 663

msdp-clear-sa-cache

Summary

Name msdp-clear-sa-cache
  
 
Clears MSDP source active (SA) cache entries.

Details

Node ID /msdp-clear-sa-cache
Module ietf-msdp
Version 2017-08-30
Config 1
Mandatory 0
Children input output
Source ietf-msdp line 676

nh-add

Summary

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

Details

Node ID /nh-add
Module ietf-i2rs-rib
Version 2017-12-05
Config 1
Mandatory 0
Children input output
Source ietf-i2rs-rib line 1979

nh-delete

Summary

Name nh-delete
  
 
To delete a nexthop from a rib

Details

Node ID /nh-delete
Module ietf-i2rs-rib
Version 2017-12-05
Config 1
Mandatory 0
Children input output
Source ietf-i2rs-rib line 2023

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 2013-07-15
Config 1
Mandatory 0
Children input output
Source yuma-system line 615

nvsave

Summary

Name nvsave
  
 
Save the running datastore to the startup datastore.

Details

Node ID /nvsave
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2654

otn-te-tunnel-path-compute

Summary

Name otn-te-tunnel-path-compute
  
 
OTN TE tunnel path computation

Details

Node ID /otn-te-tunnel-path-compute
Module ietf-otn-tunnel
Version 2017-10-30
Config 1
Mandatory 0
Children input output
Source ietf-otn-tunnel line 232

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

path-discovery

Summary

Name path-discovery
  
 
Path discovery RPC operation as per RFC7276.

Details

Node ID /path-discovery
Module ietf-connectionless-oam-methods
Version 2017-09-06
Config 1
Mandatory 0
Children input output
Source ietf-connectionless-oam-methods line 264

play

Summary

Name play
  
 
Control function for the jukebox player

Details

Node ID /play
Module example-jukebox
Version 2014-07-03
Config 1
Mandatory 0
Children input output
Source example-jukebox line 232

purge-alarms

Summary

Name purge-alarms
  
 
This operation requests the server to delete entries from the
alarm list according to the supplied criteria.  Typically it
can be used to delete alarms that are in closed operator state
and older than a specified time.  The number of purged alarms
is returned as an output parameter

Details

Node ID /purge-alarms
Module ietf-alarms
Version 2017-10-30
Config 1
Mandatory 0
Children input output
Source ietf-alarms line 1114

pwd

Summary

Name pwd
  
 
Print the current working directory.

Details

Node ID /pwd
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2650

quit

Summary

Name quit
  
 
Quit the yangcli-pro application

Details

Node ID /quit
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2659

recall

Summary

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

Details

Node ID /recall
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2663

record-test

Summary

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

Details

Node ID /record-test
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3402

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-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2681

remove

Summary

Name remove
  
 
Remove some NETCONF config data with the edit-config operation

Details

Node ID /remove
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2696

remove-all

Summary

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

Details

Node ID /remove-all
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2717

replace

Summary

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

Details

Node ID /replace
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2687

report

Summary

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

Details

Node ID /report
Module ietf-lmap-report
Version 2017-08-08
Config 1
Mandatory 0
Children input output
Source ietf-lmap-report line 41

report

Summary

Name report
  
 
The report operation is used by an LMAP measurement agent to
submit measurement results produced by measurement tasks to
a collector.

Details

Node ID /report
Module ietf-lmap-report
Version 2017-04-21
Config 1
Mandatory 0
Children input output
Source ietf-lmap-report line 40

report-progress

Summary

Name report-progress
  
 
This RPC enables a device, as identified by its RESTCONF
username, to report its bootstrapping progress to the
bootstrap server.

Details

Node ID /report-progress
Module ietf-zerotouch-bootstrap-server
Version 2017-10-19
Config 1
Mandatory 0
Children input output
Source ietf-zerotouch-bootstrap-server line 223

reset-tags

Summary

Name reset-tags
  
 
Reset a list of tags for a given module to the list of module
and implementation time defiend tags. It provides the list of
tags associated with the module post reset.

Details

Node ID /reset-tags
Module ietf-module-tags
Version 2017-10-25
Config 1
Mandatory 0
Children input output
Source ietf-module-tags line 80

restart

Summary

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

Details

Node ID /restart
Module yuma-system
Version 2013-07-15
Config 1
Mandatory 0
Children input output
Source yuma-system line 603

restore

Summary

Name restore
  
 
Restore a saved configuration on the device to the
running configuration.

Details

Node ID /restore
Module yumaworks-system
Version 2017-12-22
Config 1
Mandatory 0
Children input output
Source yumaworks-system line 208

resynch-subscription

Summary

Name resynch-subscription
  
 
This RPC allows a subscriber of an active on-change
subscription to request a full push of objects in there current
state. A successful result would be the set of YANG objects
equivalent to a Get using the existing selection criteria. This
request may only come from the same subscriber using the
establish-subscription RPC.

Details

Node ID /resynch-subscription
Module ietf-yang-push
Version 2017-10-23
Config 1
Mandatory 0
Children input output
Source ietf-yang-push line 468

revert-commit

Summary

Name revert-commit
  
 
This operation is used to cancel an ongoing confirmed commit.
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.  If not confirmed commit
procedure is in progress then the operation fails
with an 'operation-failed' error.

Details

Node ID /revert-commit
Module ietf-netconf-ex
Version 2014-04-21
Reference RFC 6241, Section 8.4.4.1
Config 1
Mandatory 0
Children input output
Source ietf-netconf-ex line 682

rib-add

Summary

Name rib-add
  
 
To add a RIB to a instance

Details

Node ID /rib-add
Module ietf-i2rs-rib
Version 2017-12-05
Config 1
Mandatory 0
Children input output
Source ietf-i2rs-rib line 1627

rib-delete

Summary

Name rib-delete
  
 
To delete a RIB from a routing instance.
After deleting the rib, all routes installed
in the RIB will be deleted as well.

Details

Node ID /rib-delete
Module ietf-i2rs-rib
Version 2017-12-05
Config 1
Mandatory 0
Children input output
Source ietf-i2rs-rib line 1671

route-add

Summary

Name route-add
  
 
To add a route or a list of route to a rib

Details

Node ID /route-add
Module ietf-i2rs-rib
Version 2017-12-05
Config 1
Mandatory 0
Children input output
Source ietf-i2rs-rib line 1742

route-delete

Summary

Name route-delete
  
 
To delete a route or a list of route from a rib

Details

Node ID /route-delete
Module ietf-i2rs-rib
Version 2017-12-05
Config 1
Mandatory 0
Children input output
Source ietf-i2rs-rib line 1793

route-update

Summary

Name route-update
  
 
To update a route or a list of route of a rib.
The inputs:
  1. The match conditions, could be:
    a. route prefix, or
    b. route attributes, or
    c. nexthop;
  2. The update parameters to be used:
    a. new nexthop;
    b. new route attributes;nexthop
Actions:
  1. update the nexthop
  2. update the route attributes
The outputs:
  success-count - the number of routes updated;
  failed-count - the number of routes fail to update
  failure-detail - the detail failure info.

Details

Node ID /route-update
Module ietf-i2rs-rib
Version 2017-12-05
Config 1
Mandatory 0
Children input output
Source ietf-i2rs-rib line 1864

run

Summary

Name run
  
 
Internal command to run a script.

Details

Node ID /run
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2741

sadb_register

Summary

Name sadb_register
  
 
Allows netconf to register its key socket as able to acquire new security associations for the kernel

Details

Node ID /sadb_register
Module ietf-ipsec
Version 2017-05-02
Config 1
Mandatory 0
Children input output
Source ietf-ipsec line 914

save

Summary

Name save
  
 
Meta command to save configuration edits.

Details

Node ID /save
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2795

session

Summary

Name session
  
 
Access an active session

Details

Node ID /session
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2876

session-cfg

Summary

Name session-cfg
  
 
Access a session configuration

Details

Node ID /session-cfg
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2889

sessions-cfg

Summary

Name sessions-cfg
  
 
Controls access to the saved sessions file

Details

Node ID /sessions-cfg
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3023

set-current-datetime

Summary

Name set-current-datetime
  
 
Set the /system-state/clock/current-datetime leaf
to the specified value.

If the system is using NTP (i.e., /system/ntp/enabled
is set to 'true'), then this operation will fail with
error-tag 'operation-failed' and error-app-tag value of
'ntp-active'.

Details

Node ID /set-current-datetime
Module ietf-system
Version 2014-08-06
Config 1
Mandatory 0
Children input output
Source ietf-system line 806

set-log-level

Summary

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

Details

Node ID /set-log-level
Module yuma-system
Version 2013-07-15
Config 1
Mandatory 0
Children input output
Source yuma-system line 245

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 2013-10-05
Config 1
Mandatory 0
Children input output
Source yuma-mysession line 82

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-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3066

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-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3083

show

Summary

Name show
  
 
Local show command for yangcli-pro session info.

Details

Node ID /show
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3130

shutdown

Summary

Name shutdown
  
 
Shutdown the server.

Details

Node ID /shutdown
Module yuma-system
Version 2013-07-15
Config 1
Mandatory 0
Children input output
Source yuma-system line 609

stamp-sender-start

Summary

Name stamp-sender-start
  
 
start the configured sender session

Details

Node ID /stamp-sender-start
Module ietf-stamp
Version 2017-10-20
Config 1
Mandatory 0
Children input output
Source ietf-stamp line 842

stamp-sender-stop

Summary

Name stamp-sender-stop
  
 
stop the configured sender session

Details

Node ID /stamp-sender-stop
Module ietf-stamp
Version 2017-10-20
Config 1
Mandatory 0
Children input output
Source ietf-stamp line 855

start-rpc-timing

Summary

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

Details

Node ID /start-rpc-timing
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3290

start-session

Summary

Name start-session
  
 
Start an active session from the specified configured
session.

Details

Node ID /start-session
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3307

start-timer

Summary

Name start-timer
  
 
Start a timer to do simple performance measurements.

Details

Node ID /start-timer
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3321

stop-rpc-timing

Summary

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

Details

Node ID /stop-rpc-timing
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3345

stop-session

Summary

Name stop-session
  
 
Terminate an active session.

Details

Node ID /stop-session
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3353

stop-timer

Summary

Name stop-timer
  
 
Stop a timer and output the delta value.

Details

Node ID /stop-timer
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3367

system-restart

Summary

Name system-restart
  
 
Request that the entire system be restarted immediately.
A server SHOULD send an rpc reply to the client before
restarting the system.

Details

Node ID /system-restart
Module ietf-system
Version 2014-08-06
Config 1
Mandatory 0
Children input output
Source ietf-system line 826

system-shutdown

Summary

Name system-shutdown
  
 
Request that the entire system be shut down immediately.
A server SHOULD send an rpc reply to the client before
shutting down the system.

Details

Node ID /system-shutdown
Module ietf-system
Version 2014-08-06
Config 1
Mandatory 0
Children input output
Source ietf-system line 834

terminal

Summary

Name terminal
  
 
Configure the terminal settings

Details

Node ID /terminal
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3462

test-suite

Summary

Name test-suite
  
 
Use the unit test-suite feature.

Details

Node ID /test-suite
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3484

traceroute

Summary

Name traceroute
  
 
Generates Traceroute or Path Trace and return response.
Referencing RFC7276 for common Toolset name, for
MPLS-TP OAM it's Route Tracing, and for TRILL OAM It's
Path Tracing tool. Starts with TTL of one and increment
by one at each hop. Untill destination reached or TTL
reach max value.

Details

Node ID /traceroute
Module ietf-connection-oriented-oam
Version 2017-06-01
Config 1
Mandatory 0
Children input output
Source ietf-connection-oriented-oam line 995

trigger-resync

Summary

Name trigger-resync
  
 
Trigger the resyncrinization at the PCE

Details

Node ID /trigger-resync
Module ietf-pcep
Version 2017-07-01
Config 1
Mandatory 0
Children input output
Source ietf-pcep line 2641

tunnels-rpc

Summary

Name tunnels-rpc
  
 
TE tunnels RPC nodes

Details

Node ID /tunnels-rpc
Module ietf-te
Version 2017-10-29
Config 1
Mandatory 0
Children input output
Source ietf-te line 1659

twamp-sender-start

Summary

Name twamp-sender-start
  
 
start the configured sender session

Details

Node ID /twamp-sender-start
Module ietf-twamp-light
Version 2017-06-13
Config 1
Mandatory 0
Children input output
Source ietf-twamp-light line 842

twamp-sender-stop

Summary

Name twamp-sender-stop
  
 
stop the configured sender session

Details

Node ID /twamp-sender-stop
Module ietf-twamp-light
Version 2017-06-13
Config 1
Mandatory 0
Children input output
Source ietf-twamp-light line 855

unload

Summary

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

Note: this operation does not remove the --module parameter
from the server configuration file if it exists.

The following conditions must be true for the unload to be
attempted by the server:

  * The module is allowed to be unloaded. It is data-model
    and vendor specific whether a module can be
    removed at run-time.

  * There are no dependencies on the module being removed.
    No modules that import this module are also loaded.

  * The module was loaded into the server, either via the
    <load> operation or the --module configuration parameter.

  * No datastores are currently locked.  The server will
    attempt to lock all datastores on behalf of the client
    for the entire unload operation.

  * The candidate datastore does not contain any edits
    that have not been committed.

  * No confirmed-commit operation is in progress.

If all these conditions are met then the server will
attempt to unload the specified module.  The unload
operation can fail for various reasons:

  * The client does not have write privileges for
    all data being deleted. This includes any
    top-level data nodes and any nested augment
    nodes in other modules.

  * The deletion of one or more nodes would cause the
    running datastore to fail any YANG validation
    tests in RFC 6020, sec. 8.3.3.

  * Server resource errors occur

Details

Node ID /unload
Module yumaworks-system
Version 2017-12-22
Config 1
Mandatory 0
Children input output
Source yumaworks-system line 233

unload-bundle

Summary

Name unload-bundle
  
 
Unload a SIL bundle from the server, if it is loaded.

Details

Node ID /unload-bundle
Module yumaworks-system
Version 2017-12-22
Config 1
Mandatory 0
Children input output
Source yumaworks-system line 320

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 2011-06-01
Reference RFC 6241, Section 7.6
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 698

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 2015-04-30
Reference RFC 4741, section 7.6
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 1077

unmount

Summary

Name unmount
  
 
This RPC allows an application or administrative user to
unmount information from a remote datastore.  If successful,
the corresponding mountpoint will be removed from the
datastore.

Details

Node ID /unmount
Module ietf-mount
Version 2017-03-30
Config 1
Mandatory 0
Children input output
Source ietf-mount line 292

unset

Summary

Name unset
  
 
Delete a specific yangcli-pro command alias.

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

Details

Node ID /unset
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3582

update-config

Summary

Name update-config
  
 
Update the configuration cache for the current session.
The current session must be connected and the
$$autoconfig system variable must be 'true',
or an error will be returned.

Details

Node ID /update-config
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3574

user-cfg

Summary

Name user-cfg
  
 
Access a user configuration

Details

Node ID /user-cfg
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2923

users-cfg

Summary

Name users-cfg
  
 
Controls access to the saved users file

Details

Node ID /users-cfg
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2981

uservars

Summary

Name uservars
  
 
Manage the yangcli-pro user variables

Details

Node ID /uservars
Module yangcli-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3599

validate

Summary

Name validate
  
 
Validates the contents of the specified configuration.

Details

Node ID /validate
Module yuma-netconf
Version 2015-04-30
Reference RFC 4741, section 8.6.4.1
Config 1
Mandatory 0
Children input output
Source yuma-netconf line 1316

validate

Summary

Name validate
  
 
Validates the contents of the specified configuration.

Details

Node ID /validate
Module ietf-netconf
Version 2011-06-01
Reference RFC 6241, Section 8.6.4.1
Config 1
Mandatory 0
Children input output
Source ietf-netconf line 882

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-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3639

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-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3661

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-pro
Version 2017-12-12
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3677