netconfcentral logo

RPC Methods

RPC Abstract
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.
close-session Request graceful termination of a NETCONF session.
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...
commit Commit the candidate configuration as the device's new current configuration
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...
connect Connect to a NETCONF server.
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-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.
discard-changes Revert the candidate configuration to the current running configuration.
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 re...
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...
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.
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
fill Fill a value for reuse in a NETCONF PDU or other operation. Used in an assignment statement to create a variable for later use: $foo = fill --target=/t:foo-con/bar-list --optional --current-value=$bar
get Retrieve running configuration and device state information.
get Retrieve running configuration and device state information.
get-config Retrieve all or part of a specified configuration.
get-config Retrieve all or part of a specified configuration.
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...
help Print the yangcli 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
kill-session Force the termination of a NETCONF session.
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...
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 ...
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.
no-op Just returns 'ok'. Used for debugging or relative performance measurements.
partial-lock A NETCONF operation that locks parts of the running datastore.
partial-unlock A NETCONF operation that releases a previously acquired partial-lock.
pwd Print the current working directory.
quit Quit the yangcli application
recall Recall the specified command line history buffer entry into the current command line.
release-locks Unlock all the server databases that were previously locked with the get-locks command.
replace Create some NETCONF config data with the edit-config operation
restart Restart the server. Does not reload the software image..
run Internal command to run a script.
save Meta command to save configuration edits.
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 info.
shutdown Shutdown the server.
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 ...
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.