netconfcentral logo

RPC Methods

RPC Abstract
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.
ber-test This is the ber-test rpc. It is supported for a service in the service-list.
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 Calling a target function for this session and getting the returned value.
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-rollback-timer Cancel roll back timer which user provisioned as part of activate command
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.
cancel-validation-timer Cancel validation timer which user provisioned as part of activate command
cd Change the current working directory.
chg-password input output
clear Clear the screen in interactive mode.
clear-authentication Clears the RSVP Security Association (SA) before the lifetime expires.
clear-neighbor RPC to clear the RSVP Hello session to a neighbor.
clear-pm Command to initialize PM data
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.
clear-session Clears RSVP sessions RPC
close-l3vpn input output
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...
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.
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...
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...
complex-ber-test This is the complex-ber-test rpc. It is supported for a service in the service-list.
complex-service-rpc-ber-test-async-callback This is the callback notification that the controller invokes on the carrier system.
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 Table 4 of RFC 7276.
continuity-check Generates continuity-check as per RFC7276 Table 4.
continuity-check Continuity Check RPC operation as per RFC 7276.
continuity-verification Generates Connectivity Verification as per Table 4 in RFC 7276.
continuity-verification Generates continuity-verification as per RFC7276 Table 4.
controller-parameters-setting Rpc used to populate controller parameters in the Data Store of the RNC.
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-l3vpn-instance input output
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 r...
database-init Initialize the database to default DB
db-activate activate the database
db-backup copy running DB to user provided file to a given path
db-restore Restore database
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-file Delete one or more files in the specified directory.
delete-l3vpn-instance input output
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 'delet...
device-cfg Access a device configuration
devices-cfg Controls access to the saved devices file
disable-automatic-shutoff input output
disable-schema-encoding This RPC is send by the client when it stops using a particular exi-schema-id.
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 res...
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. 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 star...
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.
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.
enable-password Use <enable-password> to config the password in the config mode for yp-shell.
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 t...
end End an 'if' command block or a 'while' command block. If no block is in progress then an error will occur.
equipment-notification input output
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 terminate...
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
example-cmd Example external command
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...
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 ...
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 ...
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
fw-update Fpga data update
get Retrieve running configuration and device state information.
get Retrieve running configuration and device state information.
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...
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 ...
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.
get-bulk Retrieve multiple list entries at a time
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 ...
get-config Retrieve all or part of a specified configuration.
get-config Retrieve all or part of a specified configuration.
get-connection-port-trail input output
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 ...
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 t...
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-module-tags Get the list of configured module-tags. The --module-tagmap parameter is used to configure a module-tag.
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-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-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-...
get-SF-description Get service function description information.
get-SF-monitoring-info Get current service function monitoring information.
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
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 support...
get2 Retrieve NETCONF datastore information
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.
inquire-l3vpn-instance-work-path input output
insert Insert some NETCONF config data with the edit-config operation
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 atte...
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 operatio...
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...
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...
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
link-state-update Triggers a link state update for the specific interface.
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-l3vpn-instance-ac-qos input output
modify-l3vpn-instance-basic input output
modify-l3vpn-instance-connection input output
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 t...
network-re-optimization input output
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.
odu-sncp-protection-switch ODU SNCP Protection Switch RPC with synchronous implementation
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 RFC 7276.
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-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.
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
restart Restart the server. Does not reload the software image..
restore Restore a saved configuration on the device to the running configuration.
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 ...
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 an 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 routes to a RIB
route-delete To delete a route or a list of routes from a RIB
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,...
run Internal command to run a script.
save Meta command to save configuration edits.
schema-server-cfg Access a schema-server configuration
schema-servers-cfg Controls access to the saved schema-servers file
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.
service-create-complex-result-notification-request This is the callback notification that the controller invokes on the carrier system.
service-create-result-notification-request This is the callback notification that the controller invokes on the carrier system.
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
service-delete-complex-result-notification-request This is the callback notification that the controller invokes on the carrier system.
service-delete-result-notification-request This is the callback notification that the controller invokes on the carrier system.
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 netw...
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 installe...
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.
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.
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.
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 :...
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.
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 su...
service-rpc-ber-test-async-callback This is the callback notification that the controller invokes on the carrier system.
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-current-datetime Set the info/current-datetime leaf to the specified value.
set-log-level Sets the server log verbosity level. Copied from deprecated yuma-system.yang/
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.
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.
show Local show command for yangcli-pro session info.
show-file Show one or more files in the specified directory.
shutdown Shutdown the server.
sleep Pause for a number of seconds. Intended for use in yangcli scripts.
stamp-sender-start start the configured sender session
stamp-sender-stop stop the configured sender session
start-exi Start encoding protocol messages in Efficient XML Interchange format.
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-scan input output
start-session Start an active session from the specified configured session.
start-timer Start a timer to do simple performance measurements.
stop-exi Stop encoding protocol messages in Efficient XML Interchange format. Revert back to using the usual text XML encoding.
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.
sw-activate Activate new load
sw-stage SW stage - copies the SW from repo to staging bank
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.
temp-service-create input output
temp-service-delete input output
terminal Configure the terminal settings
test-suite Use the unit test-suite feature.
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 des...
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 ...
transfer File transfer using FTP/SFTP
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 ...
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.
vn-compute The VN computation without actual instantiation
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.
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.