netconfcentral logo

RPC Methods

RPC Abstract
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.
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.
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 eit...
aliases Manage the yangcli-pro command aliases
auto-test Run automatic edit testing on the specified object
backup Backup the current running configuration to a file on the device.
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
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
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.
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.
cancel-schedule Cancels a scheduled message.
cancel-subscription Cancel a notification subscription for the session, if this session has an active subscription. If not, just return OK.
cancel-toast Stop making toast, if any is being made. A 'resource-denied' error will be returned if the toaster service is disabled.
cd Change the current working directory.
clean-client-statistics Clean client packet statistics
clean-relay-statistics Clean relay packet statistics
clean-server-statistics Clean server packet statistics
clear Clear the screen in interactive mode.
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.
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.
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.
clear-igmp-groups Clears the specified IGMP cache entries.
clear-igmp-snooping-groups Clears the specified IGMP Snooping cache tables.
clear-mld-groups Clears the specified MLD cache entires.
clear-mld-snooping-groups Clears the specified MLD Snooping cache tables.
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.
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.
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 assoc...
close-session Request graceful termination of a NETCONF session.
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 candid...
commit Commit the candidate configuration as the device's new current configuration.
compare NMDA compare operation.
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, th...
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.
config Enter the configuration mode for the current session. There must be a current active session or this command will fail.
connect Connect to a NETCONF server.
continuity-check Generates continuity-check as per RFC7276 Table 4.
continuity-check Continuity-check RPC operation as per RFC7276.
continuity-verification Generates continuity-verification as per RFC7276 Table 4.
copy-config Create or replace an entire configuration datastore with the contents of another complete configuration datastore.
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 capab...
create Create some NETCONF config data with the edit-config operation
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...
delete Delete some NETCONF config data with the edit-config operation
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.
delete-backup Delete the specified backup file on the device.
delete-config Delete a configuration datastore.
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.
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.
device-cfg Access a device configuration
devices-cfg Controls access to the saved devices file
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 res...
discard-changes Revert the candidate configuration to the current running configuration.
edit-config The <edit-config> operation loads all or part of a specified configuration to the specified target configuration.
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 t...
edit-data Edit data in an NMDA datastore.
edit2 Edit NETCONF datastore contents. All operations requested in the yang-patch edit list are applied, or the target datastore is left unchanged.
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' comman...
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.
end End an 'if' command block or a 'while' command block. If no block is in progress then an error will occur.
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 terminat...
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 var...
eventlog Access the notification event log
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 t...
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
get Retrieve running configuration and device state information.
get Retrieve running configuration and device state information.
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.
get-bulk Retrieve multiple list entries at a time
get-config Retrieve all or part of a specified configuration.
get-config Retrieve all or part of a specified configuration.
get-data Retrieve data from an NMDA datastore.
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 ...
get-my-session Get the customization settings for this session
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...
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
get2 Retrieve NETCONF datastore information
globals-rpc Execution data for TE global.
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.
help Print the yangcli-pro help text
history Access the command line history buffer
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.
insert Insert some NETCONF config data with the edit-config operation
interfaces-rpc Execution data for TE interfaces.
interfaces-rpc Execution data for TE interfaces.
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 associa...
kill-session Force the termination of a NETCONF session.
kill-subscription This RPC allows an operator to delete a dynamic subscription without restrictions on the originating subscriber or underlying transport session.
list List some NETCONF info.
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 ...
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 ...
load-bundle Load a SIL bundle into the server, if it is not already loaded.
lock The lock operation allows the client to lock the configuration system of a device.
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 c...
log-debug Write a message to the output log if the log-level is greater or equal to 'debug'.
log-error Write a message to the output log if the log-level is greater or equal to 'error'.
log-info Write a message to the output log if the log-level is greater or equal to 'info'.
log-warn Write a message to the output log if the log-level is greater or equal to 'warn'.
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.
merge Merge some NETCONF config data with the edit-config operation
mgrload Load a module or other file into the client. Use the 'load' command to load a module into the server.
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 su...
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.
mpls-ldp-clear-hello-adjacency Clears the hello adjacency
mpls-ldp-clear-peer Clears the session to the peer.
mpls-ldp-clear-peer-statistics Clears protocol statistics (e.g. sent and received counters).
msdp-clear-peer Clears the session to the peer.
msdp-clear-sa-cache Clears MSDP source active (SA) cache entries.
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.
nh-delete To delete a nexthop from a rib
no-op Just returns 'ok'. Used for debugging or relative performance measurements.
nvsave Save the running datastore to the startup datastore.
otn-te-tunnel-path-compute OTN TE tunnel path computation
partial-lock A NETCONF operation that locks parts of the running datastore.
partial-unlock A NETCONF operation that releases a previously acquired partial-lock.
path-discovery Path discovery RPC operation as per RFC7276.
play Control function for the jukebox player
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 retu...
pwd Print the current working directory.
quit Quit the yangcli-pro application
recall Recall the specified command line history buffer entry into the current command line.
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.
release-locks Unlock all the server databases that were previously locked with the get-locks command.
remove Remove some NETCONF config data with the edit-config operation
remove-all Remove some NETCONF config data with the edit-config operation. Remove all instances of a leaf-list or list object.
replace Create some NETCONF config data with the edit-config operation
report The report operation is used by a Measurement Agent to submit measurement results produced by Measurement Tasks to a Collector.
report The report operation is used by an LMAP measurement agent to submit measurement results produced by measurement tasks to a collector.
report-progress This RPC enables a device, as identified by its RESTCONF username, to report its bootstrapping progress to the bootstrap server.
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.
restart Restart the server. Does not reload the software image..
restore Restore a saved configuration on the device to the running configuration.
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 onl...
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 ...
rib-add To add a RIB to a instance
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.
route-add To add a route or a list of route to a rib
route-delete To delete a route or a list of route from a rib
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;next...
run Internal command to run a script.
sadb_register Allows netconf to register its key socket as able to acquire new security associations for the kernel
save Meta command to save configuration edits.
session Access an active session
session-cfg Access a session configuration
sessions-cfg Controls access to the saved sessions file
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'.
set-log-level Sets the server log verbosity level
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.
sget Get some NETCONF running config or state data with the get operation, using an optional subtree filter.
sget-config Get some NETCONF config data with the get-config operation, using an optional subtree filter.
show Local show command for yangcli-pro session info.
shutdown Shutdown the server.
stamp-sender-start start the configured sender session
stamp-sender-stop stop the configured sender session
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.
start-session Start an active session from the specified configured session.
start-timer Start a timer to do simple performance measurements.
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.
stop-session Terminate an active session.
stop-timer Stop a timer and output the delta value.
system-restart Request that the entire system be restarted immediately. A server SHOULD send an rpc reply to the client before restarting the system.
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.
terminal Configure the terminal settings
test-suite Use the unit test-suite feature.
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 ...
trigger-resync Trigger the resyncrinization at the PCE
tunnels-rpc TE tunnels RPC nodes
twamp-sender-start start the configured sender session
twamp-sender-stop stop the configured sender session
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 ...
unload-bundle Unload a SIL bundle from the server, if it is loaded.
unlock The unlock operation is used to release a configuration lock, previously obtained with the 'lock' operation.
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 ...
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.
unset Delete a specific yangcli-pro command alias. * Delete one alias 'foo': yangcli-pro> unset foo
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.
user-cfg Access a user configuration
users-cfg Controls access to the saved users file
uservars Manage the yangcli-pro user variables
validate Validates the contents of the specified configuration.
validate Validates the contents of the specified configuration.
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.
xget Get some NETCONF running config or state data with the get operation, using an optional XPath filter.
xget-config Get some NETCONF config data with the get-config operation, using an optional XPath filter.