netconfcentral logo

RPC Methods

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

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2033

aliases

Summary

Name aliases
  
 
Manage the yangcli-pro command aliases

Details

Node ID /aliases
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2084

auto-test

Summary

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

Details

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

backup

Summary

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

Details

Node ID /backup
Module yumaworks-system
Version 2020-03-06
Config 1
Mandatory 0
Children input output
Source yumaworks-system line 190

ber-test

Summary

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

Details

Node ID /ber-test
Module org-openroadm-ber-test
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-ber-test line 167

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2167

call

Summary

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

Details

Node ID /call
Module ieee1906-dot1-function
Version 2020-07-07
Config 1
Mandatory 0
Children input output
Source ieee1906-dot1-function line 404

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 853

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-rollback-timer

Summary

Name cancel-rollback-timer
  
 
Cancel roll back timer which user provisioned as part of activate command

Details

Node ID /cancel-rollback-timer
Module org-openroadm-database
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-database line 155

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 2020-03-06
Config 1
Mandatory 0
Children input output
Source yumaworks-system line 250

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

cancel-validation-timer

Summary

Name cancel-validation-timer
  
 
Cancel validation timer which user provisioned as part of activate command

Details

Node ID /cancel-validation-timer
Module org-openroadm-swdl
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-swdl line 185

cd

Summary

Name cd
  
 
Change the current working directory.

Details

Node ID /cd
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2203

chg-password

Summary

Name chg-password

Details

Node ID /chg-password
Module org-openroadm-user-mgmt
Version 2019-11-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-user-mgmt line 119

clear

Summary

Name clear
  
 
Clear the screen in interactive mode.

Details

Node ID /clear
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2216

clear-authentication

Summary

Name clear-authentication
  
 
Clears the RSVP Security Association (SA) before the
lifetime expires.

Details

Node ID /clear-authentication
Module ietf-rsvp
Version 2020-07-24
Config 1
Mandatory 0
Children input output
Source ietf-rsvp line 925

clear-neighbor

Summary

Name clear-neighbor
  
 
RPC to clear the RSVP Hello session to a neighbor.

Details

Node ID /clear-neighbor
Module ietf-rsvp
Version 2020-07-24
Config 1
Mandatory 0
Children input output
Source ietf-rsvp line 877

clear-pm

Summary

Name clear-pm
  
 
Command to initialize PM data

Details

Node ID /clear-pm
Module org-openroadm-pm
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-pm line 272

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 2018-02-03
Config 1
Mandatory 0
Children input output
Source ietf-rip line 1102

clear-session

Summary

Name clear-session
  
 
Clears RSVP sessions RPC

Details

Node ID /clear-session
Module ietf-rsvp
Version 2020-07-24
Config 1
Mandatory 0
Children input output
Source ietf-rsvp line 827

close-l3vpn

Summary

Name close-l3vpn

Details

Node ID /close-l3vpn
Module sd-onos-service-l3vpn
Version 2015-10-14
Config 1
Mandatory 0
Children input output
Source sd-onos-service-l3vpn line 115

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 757

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

collect-historical-pm-file

Summary

Name collect-historical-pm-file
  
 
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.

Details

Node ID /collect-historical-pm-file
Module org-openroadm-pm
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-pm line 298

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 780

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

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

complex-ber-test

Summary

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

Details

Node ID /complex-ber-test
Module org-openroadm-ber-test
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-ber-test line 183

complex-service-rpc-ber-test-async-callback

Summary

Name complex-service-rpc-ber-test-async-callback
  
 
This is the callback notification that the controller invokes on the carrier system.

Details

Node ID /complex-service-rpc-ber-test-async-callback
Module org-openroadm-ber-test
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-ber-test line 224

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2220

connect

Summary

Name connect
  
 
Connect to a NETCONF server.

Details

Node ID /connect
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2237

continuity-check

Summary

Name continuity-check
  
 
Generates Continuity Check as per Table 4 of RFC 7276.

Details

Node ID /continuity-check
Module ietf-connection-oriented-oam
Version 2019-04-16
Config 1
Mandatory 0
Children input output
Source ietf-connection-oriented-oam line 803

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 2018-02-07
Config 1
Mandatory 0
Children input output
Source ietf-connection-oriented-oam line 792

continuity-check

Summary

Name continuity-check
  
 
Continuity Check RPC operation as per RFC 7276.

Details

Node ID /continuity-check
Module ietf-connectionless-oam-methods
Version 2019-04-16
Reference RFC 7276: An Overview of Operations, Administration, and Maintenance (OAM) Tools
Config 1
Mandatory 0
Children input output
Source ietf-connectionless-oam-methods line 218

continuity-verification

Summary

Name continuity-verification
  
 
Generates Connectivity Verification as per Table 4 in RFC 7276.

Details

Node ID /continuity-verification
Module ietf-connection-oriented-oam
Version 2019-04-16
Config 1
Mandatory 0
Children input output
Source ietf-connection-oriented-oam line 890

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 2018-02-07
Config 1
Mandatory 0
Children input output
Source ietf-connection-oriented-oam line 880

controller-parameters-setting

Summary

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

Details

Node ID /controller-parameters-setting
Module org-openroadm-controller-customization
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-controller-customization line 543

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 532

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2263

create-l3vpn-instance

Summary

Name create-l3vpn-instance

Details

Node ID /create-l3vpn-instance
Module sd-onos-service-l3vpn
Version 2015-10-14
Config 1
Mandatory 0
Children input output
Source sd-onos-service-l3vpn line 99

create-tech-info

Summary

Name create-tech-info
  
 
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.

Details

Node ID /create-tech-info
Module org-openroadm-device
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-device line 2386

database-init

Summary

Name database-init
  
 
Initialize the database to default DB

Details

Node ID /database-init
Module org-openroadm-database
Version 2020-05-29
Config 1
Mandatory 0
Children output input
Source org-openroadm-database line 170

db-activate

Summary

Name db-activate
  
 
activate the database

Details

Node ID /db-activate
Module org-openroadm-database
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-database line 140

db-backup

Summary

Name db-backup
  
 
copy  running DB to user provided file to a given path

Details

Node ID /db-backup
Module org-openroadm-database
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-database line 100

db-restore

Summary

Name db-restore
  
 
Restore database 

Details

Node ID /db-restore
Module org-openroadm-database
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-database line 117

delete

Summary

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

Details

Node ID /delete
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2272

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2301

delete-backup

Summary

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

Details

Node ID /delete-backup
Module yumaworks-system
Version 2020-03-06
Config 1
Mandatory 0
Children input output
Source yumaworks-system line 216

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 620

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

Summary

Name delete-file
  
 
Delete one or more files in the specified directory.

Details

Node ID /delete-file
Module org-openroadm-file-transfer
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-file-transfer line 204

delete-l3vpn-instance

Summary

Name delete-l3vpn-instance

Details

Node ID /delete-l3vpn-instance
Module sd-onos-service-l3vpn
Version 2015-10-14
Config 1
Mandatory 0
Children input output
Source sd-onos-service-l3vpn line 107

delete-subscription

Summary

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

Details

Node ID /delete-subscription
Module ietf-subscribed-notifications
Version 2019-09-09
Config 1
Mandatory 0
Children input output
Source ietf-subscribed-notifications line 789

device-cfg

Summary

Name device-cfg
  
 
Access a device configuration

Details

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

devices-cfg

Summary

Name devices-cfg
  
 
Controls access to the saved devices file

Details

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

disable-automatic-shutoff

Summary

Name disable-automatic-shutoff

Details

Node ID /disable-automatic-shutoff
Module org-openroadm-device
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-device line 2439

disable-schema-encoding

Summary

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

Details

Node ID /disable-schema-encoding
Module ietf-netconf-exi
Version 2014-03-03
Config 1
Mandatory 0
Children input output
Source ietf-netconf-exi line 203

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 844

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

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 416

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.

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.

Details

Node ID /edit-data
Module ietf-netconf-nmda
Version 2019-01-07
Config 1
Mandatory 0
Children input output
Source ietf-netconf-nmda line 265

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2327

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2344

enable

Summary

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

Details

Node ID /enable
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2356

enable-password

Summary

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

Details

Node ID /enable-password
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2382

enable-schema-encoding

Summary

Name enable-schema-encoding
  
 
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.

Details

Node ID /enable-schema-encoding
Module ietf-netconf-exi
Version 2014-03-03
Config 1
Mandatory 0
Children input output
Source ietf-netconf-exi line 177

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2399

equipment-notification

Summary

Name equipment-notification

Details

Node ID /equipment-notification
Module org-openroadm-service
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-service line 383

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

Details

Node ID /establish-subscription
Module ietf-subscribed-notifications
Version 2019-09-09
Config 1
Mandatory 0
Children input output
Source ietf-subscribed-notifications line 658

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2406

eventlog

Summary

Name eventlog
  
 
Access the notification event log

Details

Node ID /eventlog
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2472

example-cmd

Summary

Name example-cmd
  
 
Example external command

Details

Node ID /example-cmd
Module example-fan
Version 2018-03-17
Config 1
Mandatory 0
Children input output
Source example-fan line 60

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2513

factory-reset

Summary

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

Details

Node ID /factory-reset
Module ietf-factory-default
Version 2020-08-31
Config 1
Mandatory 0
Children input output
Source ietf-factory-default line 64

factory-reset

Summary

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

Details

Node ID /factory-reset
Module ietf-factory-default
Version 2019-11-27
Config 1
Mandatory 0
Children input output
Source ietf-factory-default line 64

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2522

fw-update

Summary

Name fw-update
  
 
Fpga data update

Details

Node ID /fw-update
Module org-openroadm-fwdl
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-fwdl line 96

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 731

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-allowed-identities

Summary

Name get-allowed-identities
  
 
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

Details

Node ID /get-allowed-identities
Module ietf-yang-conformance
Version 2014-09-24
Config 1
Mandatory 0
Children input output
Source ietf-yang-conformance line 68

get-allowed-leafrefs

Summary

Name get-allowed-leafrefs
  
 
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

Details

Node ID /get-allowed-leafrefs
Module ietf-yang-conformance
Version 2014-09-24
Config 1
Mandatory 0
Children input output
Source ietf-yang-conformance line 134

get-bootstrapping-data

Summary

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

Details

Node ID /get-bootstrapping-data
Module ietf-sztp-bootstrap-server
Version 2019-04-30
Config 1
Mandatory 0
Children input output
Source ietf-sztp-bootstrap-server line 75

get-bulk

Summary

Name get-bulk
  
 
Retrieve multiple list entries at a time

Details

Node ID /get-bulk
Module yumaworks-getbulk
Version 2018-04-06
Config 1
Mandatory 0
Children input output
Source yumaworks-getbulk line 111

get-capabilities

Summary

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

Details

Node ID /get-capabilities
Module yumaworks-opsmgr
Version 2018-07-10
Config 1
Mandatory 0
Children input output
Source yumaworks-opsmgr line 30

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 361

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-connection-port-trail

Summary

Name get-connection-port-trail

Details

Node ID /get-connection-port-trail
Module org-openroadm-device
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-device line 2416

get-data

Summary

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

Details

Node ID /get-data
Module ietf-netconf-nmda
Version 2019-01-07
Config 1
Mandatory 0
Children input output
Source ietf-netconf-nmda line 111

get-event-log

Summary

Name get-event-log
  
 
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.

Details

Node ID /get-event-log
Module yumaworks-opsmgr
Version 2018-07-10
Config 1
Mandatory 0
Children input output
Source yumaworks-opsmgr line 67

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2552

get-module-tags

Summary

Name get-module-tags
  
 
Get the list of configured module-tags.
The --module-tagmap parameter is used to configure
a module-tag.

Details

Node ID /get-module-tags
Module yumaworks-system
Version 2020-03-06
Config 1
Mandatory 0
Children output input
Source yumaworks-system line 475

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 512

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

get-schema

Summary

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

Details

Node ID /get-schema
Module ietf-netconf-state
Version 2009-06-16
Config 1
Mandatory 0
Children input output
Source ietf-netconf-state line 358

get-SF-description

Summary

Name get-SF-description
  
 
Get service function description information.

Details

Node ID /get-SF-description
Module service-function-description-monitor-report
Version 2014-11-05
Config 1
Mandatory 0
Children output input
Source service-function-description-monitor-report line 180

get-SF-monitoring-info

Summary

Name get-SF-monitoring-info
  
 
Get current service function monitoring information.

Details

Node ID /get-SF-monitoring-info
Module service-function-description-monitor-report
Version 2014-11-05
Config 1
Mandatory 0
Children output input
Source service-function-description-monitor-report line 190

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

get-walk

Summary

Name get-walk
  
 
Walk the entries of a YANG list using the netconfd-pro
<get-bulk> operation. This command will send <get-bulk>
requests to the server until the entire list has been
retrieved or the user quits the walk.

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.

Details

Node ID /get-walk
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2593

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

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2709

help

Summary

Name help
  
 
Print the yangcli-pro help text

Details

Node ID /help
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2781

history

Summary

Name history
  
 
Access the command line history buffer

Details

Node ID /history
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2816

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2860

inquire-l3vpn-instance-work-path

Summary

Name inquire-l3vpn-instance-work-path

Details

Node ID /inquire-l3vpn-instance-work-path
Module sd-onos-service-l3vpn
Version 2015-10-14
Config 1
Mandatory 0
Children input output
Source sd-onos-service-l3vpn line 187

insert

Summary

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

Details

Node ID /insert
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2873

invoke-action

Summary

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

Details

Node ID /invoke-action
Module yumaworks-opsmgr
Version 2018-07-10
Config 1
Mandatory 0
Children input output
Source yumaworks-opsmgr line 252

invoke-rpc

Summary

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

Details

Node ID /invoke-rpc
Module yumaworks-opsmgr
Version 2018-07-10
Config 1
Mandatory 0
Children input output
Source yumaworks-opsmgr line 200

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 764

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

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

Details

Node ID /kill-subscription
Module ietf-subscribed-notifications
Version 2019-09-09
Config 1
Mandatory 0
Children input output
Source ietf-subscribed-notifications line 811

led-control

Summary

Name led-control
  
 
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

Details

Node ID /led-control
Module org-openroadm-device
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-device line 2343

link-state-update

Summary

Name link-state-update
  
 
Triggers a link state update for the specific interface.

Details

Node ID /link-state-update
Module ietf-te-device
Version 2020-07-12
Config 1
Mandatory 0
Children input output
Source ietf-te-device line 647

list

Summary

Name list
  
 
List some NETCONF info.

Details

Node ID /list
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2930

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 2020-03-06
Config 1
Mandatory 0
Children input output
Source yumaworks-system line 438

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 2020-03-06
Config 1
Mandatory 0
Children input output
Source yumaworks-system line 319

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 653

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2979

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3009

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 2994

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3024

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3039

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3048

modify-l3vpn-instance-ac-qos

Summary

Name modify-l3vpn-instance-ac-qos

Details

Node ID /modify-l3vpn-instance-ac-qos
Module sd-onos-service-l3vpn
Version 2015-10-14
Config 1
Mandatory 0
Children input output
Source sd-onos-service-l3vpn line 144

modify-l3vpn-instance-basic

Summary

Name modify-l3vpn-instance-basic

Details

Node ID /modify-l3vpn-instance-basic
Module sd-onos-service-l3vpn
Version 2015-10-14
Config 1
Mandatory 0
Children input output
Source sd-onos-service-l3vpn line 133

modify-l3vpn-instance-connection

Summary

Name modify-l3vpn-instance-connection

Details

Node ID /modify-l3vpn-instance-connection
Module sd-onos-service-l3vpn
Version 2015-10-14
Config 1
Mandatory 0
Children input output
Source sd-onos-service-l3vpn line 168

modify-subscription

Summary

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

Details

Node ID /modify-subscription
Module ietf-subscribed-notifications
Version 2019-09-09
Config 1
Mandatory 0
Children input output
Source ietf-subscribed-notifications line 735

network-re-optimization

Summary

Name network-re-optimization

Details

Node ID /network-re-optimization
Module org-openroadm-service
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-service line 663

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 2018-09-13
Config 1
Mandatory 0
Children input output
Source ietf-i2rs-rib line 2017

nh-delete

Summary

Name nh-delete
  
 
To delete a nexthop from a RIB

Details

Node ID /nh-delete
Module ietf-i2rs-rib
Version 2018-09-13
Config 1
Mandatory 0
Children input output
Source ietf-i2rs-rib line 2061

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3074

odu-sncp-protection-switch

Summary

Name odu-sncp-protection-switch
  
 
ODU SNCP Protection Switch RPC with synchronous implementation

Details

Node ID /odu-sncp-protection-switch
Module org-openroadm-prot-otn-linear-aps
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-prot-otn-linear-aps line 312

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 34

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 64

path-discovery

Summary

Name path-discovery
  
 
Path discovery RPC operation as per RFC 7276.

Details

Node ID /path-discovery
Module ietf-connectionless-oam-methods
Version 2019-04-16
Reference RFC 7276: An Overview of Operations, Administration, and Maintenance (OAM) Tools
Config 1
Mandatory 0
Children input output
Source ietf-connectionless-oam-methods line 340

pwd

Summary

Name pwd
  
 
Print the current working directory.

Details

Node ID /pwd
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3070

quit

Summary

Name quit
  
 
Quit the yangcli-pro application

Details

Node ID /quit
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3079

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

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3980

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3101

remove

Summary

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

Details

Node ID /remove
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3116

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3137

replace

Summary

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

Details

Node ID /replace
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3107

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

Summary

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

Details

Node ID /report-progress
Module ietf-sztp-bootstrap-server
Version 2019-04-30
Config 1
Mandatory 0
Children input output
Source ietf-sztp-bootstrap-server line 211

restart

Summary

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

Details

Node ID /restart
Module org-openroadm-de-operations
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-de-operations line 104

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 2020-03-06
Config 1
Mandatory 0
Children input output
Source yumaworks-system line 232

resync-subscription

Summary

Name resync-subscription
  
 
This RPC allows a subscriber of an active on-change
subscription to request a full push of objects.

A successful invocation results in a 'push-update' of all
datastore nodes that the subscriber is permitted to access.
This RPC can only be invoked on the same session on which the
subscription is currently active.  In the case of an error, a
'resync-subscription-error' is sent as part of an error
response.

Details

Node ID /resync-subscription
Module ietf-yang-push
Version 2019-09-09
Config 1
Mandatory 0
Children input output
Source ietf-yang-push line 509

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 an instance

Details

Node ID /rib-add
Module ietf-i2rs-rib
Version 2018-09-13
Config 1
Mandatory 0
Children input output
Source ietf-i2rs-rib line 1660

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 2018-09-13
Config 1
Mandatory 0
Children input output
Source ietf-i2rs-rib line 1704

route-add

Summary

Name route-add
  
 
To add a route or a list of routes to a RIB

Details

Node ID /route-add
Module ietf-i2rs-rib
Version 2018-09-13
Config 1
Mandatory 0
Children input output
Source ietf-i2rs-rib line 1780

route-delete

Summary

Name route-delete
  
 
To delete a route or a list of routes from a RIB

Details

Node ID /route-delete
Module ietf-i2rs-rib
Version 2018-09-13
Config 1
Mandatory 0
Children input output
Source ietf-i2rs-rib line 1831

route-update

Summary

Name route-update
  
 
To update a route or a list of routes of a RIB.
The inputs:
  1. The match conditions, which could be:
    a. route prefix,
    b. route attributes, or
    c. nexthop.
  2. The update parameters to be used:
    a. new nexthop,
    b. new route attributes, or
    c. 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 2018-09-13
Config 1
Mandatory 0
Children input output
Source ietf-i2rs-rib line 1902

run

Summary

Name run
  
 
Internal command to run a script.

Details

Node ID /run
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3161

save

Summary

Name save
  
 
Meta command to save configuration edits.

Details

Node ID /save
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3215

schema-server-cfg

Summary

Name schema-server-cfg
  
 
Access a schema-server configuration

Details

Node ID /schema-server-cfg
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3489

schema-servers-cfg

Summary

Name schema-servers-cfg
  
 
Controls access to the saved schema-servers file

Details

Node ID /schema-servers-cfg
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3537

service-create

Summary

Name service-create
  
 
Whether this request passed initial validation and was accepted for processing. Once the request completes processing, a
service-rpc-result Notification shall be sent.

Details

Node ID /service-create
Module org-openroadm-service
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-service line 195

service-create-complex-result-notification-request

Summary

Name service-create-complex-result-notification-request
  
 
This is the callback notification that the controller invokes on the carrier system.

Details

Node ID /service-create-complex-result-notification-request
Module org-openroadm-service
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-service line 250

service-create-result-notification-request

Summary

Name service-create-result-notification-request
  
 
This is the callback notification that the controller invokes on the carrier system.

Details

Node ID /service-create-result-notification-request
Module org-openroadm-service
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-service line 238

service-delete

Summary

Name service-delete
  
 
Whether this request passed initial validation and was accepted for processing. Once the request completes processing, a
service-rpc-result Notification shall be sent. Once the service has been deleted, it no longer will appear in the service list

Details

Node ID /service-delete
Module org-openroadm-service
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-service line 342

service-delete-complex-result-notification-request

Summary

Name service-delete-complex-result-notification-request
  
 
This is the callback notification that the controller invokes on the carrier system.

Details

Node ID /service-delete-complex-result-notification-request
Module org-openroadm-service
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-service line 274

service-delete-result-notification-request

Summary

Name service-delete-result-notification-request
  
 
This is the callback notification that the controller invokes on the carrier system.

Details

Node ID /service-delete-result-notification-request
Module org-openroadm-service
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-service line 262

service-feasibility-check

Summary

Name service-feasibility-check
  
 
Whether a service was possible to be created, and if so
the routing constraints match and the a and z end connection that have
to match
Takes a potential service and determines if it is possible in the network
using equipment that is installed on the network, formally planned or proposed for planning.
No resources are reserved, provisioned or planned as a result of this operation

Details

Node ID /service-feasibility-check
Module org-openroadm-service
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-service line 286

service-feasibility-check-bulk

Summary

Name service-feasibility-check-bulk
  
 
Whether a service was possible to be created, and if so
the routing constraints match and the a and z end connection that have
to match

Takes a list of potential services and determines if they are possible in the network
using equipment that is installed on the network, formally planned or proposed for planning.
All services are treated collectively to ensure that a given resource is not used more than once.
No resources are reserved, provisioned or planned as a result of this operation

Details

Node ID /service-feasibility-check-bulk
Module org-openroadm-service
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-service line 311

service-reconfigure

Summary

Name service-reconfigure
  
 
Whether this request passed initial validation and was accepted for processing. Once the request completes processing, a
service-rpc-result Notification shall be sent.

Details

Node ID /service-reconfigure
Module org-openroadm-service
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-service line 495

service-reroute

Summary

Name service-reroute
  
 
Whether this request was validated and processed correctly. If successful, it returns the proposed new route.
If acceptable, this request should be followed by a service-reroute-confirm to complete the reroute operation.

Details

Node ID /service-reroute
Module org-openroadm-service
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-service line 623

service-reroute-confirm

Summary

Name service-reroute-confirm
  
 
Whether this request passed initial validation and was accepted for processing. Once the request completes processing, a
service-rpc-result Notification shall be sent.

Details

Node ID /service-reroute-confirm
Module org-openroadm-service
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-service line 644

service-restoration

Summary

Name service-restoration
  
 
Whether this request passed initial validation and was accepted for processing. Once the request completes processing, a
service-rpc-result Notification shall be sent.
This rpc can be use to reroute a service according to 2 possible options :
 	_Option1 : neither the backup-path-id nor the failure-case-id are provided, a new path shall be
    calculated according to the parameters provided (which includes metrics). If path computation
    is successful, a new path is provided, and the service is rerouted according to that path.
 	_Option2 : if a backup-path-id or a failure-case-id are provided, the service shall
    be rerouted according to the corresponding path. If path computation is triggered and successful,
    a new path is provided, and the service is rerouted according to that path.

Details

Node ID /service-restoration
Module org-openroadm-service
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-service line 542

service-reversion

Summary

Name service-reversion
  
 
Whether this request passed initial validation and was accepted for processing. Once the request completes processing, a
service-rpc-result Notification shall be sent.

Details

Node ID /service-reversion
Module org-openroadm-service
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-service line 600

service-roll

Summary

Name service-roll
  
 
This rpc can be use to roll a service according to 2 possible options :
  A new path may (no path pre-calculation) or may not be calculated according
  to the parameters provided (which includes metrics). If path computation has been triggered
  and is successful, a new path is provided, and the service can be rolled according to that path.

Details

Node ID /service-roll
Module org-openroadm-service
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-service line 469

service-rpc-ber-test-async-callback

Summary

Name service-rpc-ber-test-async-callback
  
 
This is the callback notification that the controller invokes on the carrier system.

Details

Node ID /service-rpc-ber-test-async-callback
Module org-openroadm-ber-test
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-ber-test line 199

session

Summary

Name session
  
 
Access an active session

Details

Node ID /session
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3342

session-cfg

Summary

Name session-cfg
  
 
Access a session configuration

Details

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

sessions-cfg

Summary

Name sessions-cfg
  
 
Controls access to the saved sessions file

Details

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

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 764

set-current-datetime

Summary

Name set-current-datetime
  
 
Set the info/current-datetime leaf to the specified value.

Details

Node ID /set-current-datetime
Module org-openroadm-device
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-device line 2520

set-log-level

Summary

Name set-log-level
  
 
Sets the server log verbosity level.
Copied from deprecated yuma-system.yang/

Details

Node ID /set-log-level
Module yumaworks-system
Version 2020-03-06
Config 1
Mandatory 0
Children input output
Source yumaworks-system line 495

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3622

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

sget-data

Summary

Name sget-data
  
 
Get some NETCONF datastore data with the <get-data>
operation, using an optional subtree filter.
The server must support the <get-data> operation
from the ietf-netconf-nmda module.

Details

Node ID /sget-data
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3686

show

Summary

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

Details

Node ID /show
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3708

show-file

Summary

Name show-file
  
 
Show one or more files in the specified directory.

Details

Node ID /show-file
Module org-openroadm-file-transfer
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-file-transfer line 154

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

sleep

Summary

Name sleep
  
 
Pause for a number of seconds. Intended for use
in yangcli scripts.

Details

Node ID /sleep
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3219

stamp-sender-start

Summary

Name stamp-sender-start
  
 
start the configured sender session

Details

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

stamp-sender-stop

Summary

Name stamp-sender-stop
  
 
stop the configured sender session

Details

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

start-exi

Summary

Name start-exi
  
 
Start encoding protocol messages in Efficient XML
Interchange format.

Details

Node ID /start-exi
Module ietf-netconf-exi
Version 2014-03-03
Reference I-D.varga-netconf-exi-capability
Config 1
Mandatory 0
Children input output
Source ietf-netconf-exi line 86

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3868

start-scan

Summary

Name start-scan

Details

Node ID /start-scan
Module org-openroadm-device
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-device line 2478

start-session

Summary

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

Details

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

start-timer

Summary

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

Details

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

stop-exi

Summary

Name stop-exi
  
 
Stop encoding protocol messages in Efficient XML
Interchange format. Revert back to using the usual text
XML encoding.

Details

Node ID /stop-exi
Module ietf-netconf-exi
Version 2014-03-03
Config 1
Mandatory 0
Children input output
Source ietf-netconf-exi line 107

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 3923

stop-session

Summary

Name stop-session
  
 
Terminate an active session.

Details

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

stop-timer

Summary

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

Details

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

sw-activate

Summary

Name sw-activate
  
 
Activate new load

Details

Node ID /sw-activate
Module org-openroadm-swdl
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-swdl line 165

sw-stage

Summary

Name sw-stage
  
 
SW stage - copies the SW from repo to staging bank

Details

Node ID /sw-stage
Module org-openroadm-swdl
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-swdl line 148

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 784

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 792

temp-service-create

Summary

Name temp-service-create

Details

Node ID /temp-service-create
Module org-openroadm-service
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-service line 423

temp-service-delete

Summary

Name temp-service-delete

Details

Node ID /temp-service-delete
Module org-openroadm-service
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-service line 457

terminal

Summary

Name terminal
  
 
Configure the terminal settings

Details

Node ID /terminal
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 4040

test-suite

Summary

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

Details

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

traceroute

Summary

Name traceroute
  
 
Generates Traceroute or Path Trace and returns response.
References RFC 7276 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 increments
by one at each hop until the destination is reached or TTL
reaches max value.

Details

Node ID /traceroute
Module ietf-connection-oriented-oam
Version 2019-04-16
Config 1
Mandatory 0
Children input output
Source ietf-connection-oriented-oam line 970

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 2018-02-07
Config 1
Mandatory 0
Children input output
Source ietf-connection-oriented-oam line 962

transfer

Summary

Name transfer
  
 
File transfer using FTP/SFTP

Details

Node ID /transfer
Module org-openroadm-file-transfer
Version 2020-05-29
Config 1
Mandatory 0
Children input output
Source org-openroadm-file-transfer line 108

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 2020-03-06
Config 1
Mandatory 0
Children input output
Source yumaworks-system line 257

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 2020-03-06
Config 1
Mandatory 0
Children input output
Source yumaworks-system line 335

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 692

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

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 4160

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 4152

user-cfg

Summary

Name user-cfg
  
 
Access a user configuration

Details

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

users-cfg

Summary

Name users-cfg
  
 
Controls access to the saved users file

Details

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

uservars

Summary

Name uservars
  
 
Manage the yangcli-pro user variables

Details

Node ID /uservars
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 4177

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 875

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

vn-compute

Summary

Name vn-compute
  
 
The VN computation without actual
instantiation

Details

Node ID /vn-compute
Module ietf-actn-vn
Version 2018-02-27
Config 1
Mandatory 0
Children input output
Source ietf-actn-vn line 485

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 4217

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 4239

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 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 4255

xget-data

Summary

Name xget-data
  
 
Get some NETCONF datastore data with the <get-data>
operation, using an optional XPath filter.
The server must support the <get-data> operation
from the ietf-netconf-nmda module.

Details

Node ID /xget-data
Module yangcli-pro
Version 2019-12-07
Config 1
Mandatory 0
Children input output
Source yangcli-pro line 4302