Converted from YANG file 'yangcli.yang' by yangdump version 2.2.1737 Module: yangcli Organization: Netconf Central Version: 2011-10-10 Contact: Andy Bierman <support@netconfcentral.org>. Command Line Interface for the NETCONF protocol: Client side Usage: yangcli [parameters] yangcli --help yangcli --version Normal Mode: An interactive CLI shell with command line history. Autostart-mode: If the 'server' parameter is present, then yangcli will attempt to connect to that server upon startup. If the 'user' and 'password' parameters are also present, then the user will not be prompted before the connection is attempted. This parameter will be processed first, if script-mode or batch-mode is used. Script-mode: If the 'run-script' or 'run-command' parameter is present, then the specified script or command will be run automatically upon startup. Batch-mode: If the 'batch-mode' parameter is present, then either the 'run-script' or 'run-command' parameter will be invoked, if present, and then the program will exit. Any interactive input breaks in the script or command will be skipped. /usr/share/yuma/modules/netconfcentral/yangcli.yang Netconf Central Andy Bierman <support@netconfcentral.org>. 2011-10-10 Add CLI parameters: --aliases-file --autoaliases --autouservars --uservars-file --home Add yangcli local commands: alias aliases unset uservars 2011-09-05 Add 'json' to --display-mode enumerations. 2011-08-06 Add --transport to ConnectParms grouping. 2011-07-19 Add PublicKeyParms grouping. Added MatchParms (--match-names and --alt-names). Added --force-target parameter. Added show session command. Added --urltarget=<url> parameter to FillParms grouping to allow URL encoded requests to be converted to XPath before use. Added --use-xmlheader=<boolean> parameter to control how XML file variables are generated when written. 2011-06-05 Added start-timer and stop-timer local RPC functions. Added --echo-replies parameter and system variable. Added --time-rpcs parameter and system variable Added remove command for base:1.1 support 2011-04-22 Added --protocols parm via uses ProtocolsParm. Also allow setting --protocols in <connect> RPC. 2011-03-19 Added 'xml-nons' display mode to display-mode parameter. Added 'cli' and 'system' to show command; subset of show vars. Changed history show default from -1 to 25. 2010-04-16 Added eval command for XPath expression support 2010-01-14 Initial published version for 0.9.9 release Number of log entries. -1 means all entries Index into a log buffer. Identifier for a local timer to use with the start-timer and stop-timer commands. Defines the search mode that should be used when resolving YANG node names in leafs and leaf-lists using the UrlPath data type. The name must exactly match the node name for all characters in both name strings. 0 The name must match the node name for all characters in both name strings. Strings are not case-sensitive. 1 The name must exactly match the first N characters of just one node name, which must be the only partial name match found. 2 The name must exactly match the first N characters of just one node name, which must be the only partial name match found. Strings are not case-sensitive. 3 The name must exactly match the first N characters of any node name. The first one found will be used. 4 The name must exactly match the first N characters of any node name. The first one found will be used. Strings are not case-sensitive. 5 Defines the alternate name search mode that should be used when resolving YANG node names in leafs or leaflists using the UrlPath data type. If 'true' then nodes with an 'alt-name' defined will be considered a match if the YANG name or the alternative name matches the search string. If 'false' then only the YANG node name will be used in node name searches. Special URL encoded path expression. Normal Encoding Rules: - Normal content is encoded as an absolute path. - Keys are encoded as a path step within the URL, instead of a predicate expression like XPath. - The first character must be a forward slash '/'. - Each identifier or key encoded in the URL string is separated by a single forward slash '/' character. - Escaped character sequences are allowed, such as '%20' for the space ' ' character. - If any descendant nodes of a list are included, then all key leafs for that list must be encoded in the URL (or escaped with the dash '-' character to skip that key). - Only key leafs can be encoded within the URL string, similar to a YANG instance-identifier or schema-instance-identifier string. Other leafs are not allowed. Example URL and XPath strings: XPath: /foo/bar[id='fred'][id2='barney]/baz UrlPath: /foo/bar/fred/barney/baz Example showing the 'id2' key leaf escaped: XPath: /foo/bar[id='fred']/baz UrlPath: /foo/bar/fred/-/baz Special Encoding Rules Since these escaped characters are usually decoded by the time an HTTP gateway program will get them, the forward slash '/' character needs to be treated differently. To use this character within key leaf content, it must be escaped with another forward slash character. Example showing escaped forward slash in content: XPath: /interfaces/interface[name='1/0/22']/mtu URLPath: /interfaces/interface/1//0//22/mtu Name Matching A parameter using the 'NameMatchMode' data type can be used to control how name node searches are done for nodes using this data type. Alternate Naming A parameter using the 'AltNameMode' data type can be used to control whether alternative node names can be used when name searches are done for nodes using this data type. Exceptions: XML namespaces are not ignored, but if multiple sibling nodes have the same local-name, then the first node found will be used. yangcli user and system variable types Session variable (for future use) 0 Local user variable 1 User configuration variable 2 Global user variable 3 System variable 4 System internal Queue variable 5 Match mode to use for UrlPath name searches. Match mode to use for UrlPath name searches. target-parm target XPath target object to fill. If prefixes are missing then the first match in any namespace will be used. Any prefix used must be the default prefix assigned to the desired YANG module. Prefix usage is optional. true urltarget URL encoded target object to fill. Encoding Rules: TBD. true If present, then prompt for leafs that are optional. If not, skip these objects. Contains a string representing the content to use for the filled variable. If a string is entered, then the target value being filled must be a leaf or leaf-list. If a variable is referenced, then it will be used as the content, if the target value being filled is a leaf or a leaf-list. If the target value is a complex object, then the referenced variable must also be a complex object of the same type. E.g., The global variable 'foo' would be specified as: value=$$foo The local variable 'bar' would be specified as: value=$bar An error will be reported if the global or local variable does not reference the same object type as the target parameter. Match mode to use for UrlPath name searches. true Match mode to use for UrlPath name searches. true Common parms for some local commands that generate NETCONF PDUs from true varref Use the contents of the specified variable as the content from-cli target-parm target XPath target object to fill. If prefixes are missing then the first match in any namespace will be used. Any prefix used must be the default prefix assigned to the desired YANG module. Prefix usage is optional. true urltarget URL encoded target object to fill. Encoding Rules: TBD. true If present, then prompt for leafs that are optional. If not, skip these objects. Contains a string representing the content to use for the filled variable. If a string is entered, then the target value being filled must be a leaf or leaf-list. If a variable is referenced, then it will be used as the content, if the target value being filled is a leaf or a leaf-list. If the target value is a complex object, then the referenced variable must also be a complex object of the same type. E.g., The global variable 'foo' would be specified as: value=$$foo The local variable 'bar' would be specified as: value=$bar An error will be reported if the global or local variable does not reference the same object type as the target parameter. Match mode to use for UrlPath name searches. Match mode to use for UrlPath name searches. Common parms for create, merge, replace commands from true true varref Use the contents of the specified variable as the content from-cli target-parm target XPath target object to fill. If prefixes are missing then the first match in any namespace will be used. Any prefix used must be the default prefix assigned to the desired YANG module. Prefix usage is optional. true urltarget URL encoded target object to fill. Encoding Rules: TBD. true If present, then prompt for leafs that are optional. If not, skip these objects. Contains a string representing the content to use for the filled variable. If a string is entered, then the target value being filled must be a leaf or leaf-list. If a variable is referenced, then it will be used as the content, if the target value being filled is a leaf or a leaf-list. If the target value is a complex object, then the referenced variable must also be a complex object of the same type. E.g., The global variable 'foo' would be specified as: value=$$foo The local variable 'bar' would be specified as: value=$bar An error will be reported if the global or local variable does not reference the same object type as the target parameter. Match mode to use for UrlPath name searches. Match mode to use for UrlPath name searches. Timeout to use seconds Common parms for sget and sget-config operations. If present, and the 'from-cli' option is used for input, then filling of mandatory nodes and key leafs will be skipped. Instead, the target object will be treated as a terminating select node in the filter element. Common parms for xget and xget-config operations. from true varref Use the contents of the specified variable as the content select The XPath expression to use in the retrieval operation. The string may only contain single quotes, which are required for string literals. The entire string will be inserted into a double-quoted string, within the get-config PDU. Character entities will be inserted as needed to maintain well-formed XML. urltarget The URL path expression to use in the retrieval operation. Timeout to use seconds Match mode to use for UrlPath name searches. true Match mode to use for UrlPath name searches. true Common parms for connecting to a NETCONF server. Used by the connect operation and if present at the command line invocation, then the connect operation will be invoked automatically. User name to use for NETCONF sessions. IP address or DNS name of the NETCONF server target. User password to use for NETCONF sessions. If none, then user will be prompted before connecting. NETCONF port number to use. If not present, then port 830, followed by port 22, will be tried. Number of seconds to wait for a response from the server before declaring a timeout. Zero means do not timeout at all. seconds Contains the file path specification for the file containing the client-side public key. If both 'public-key' and 'private-key' files are present, the client will attempt to connect to the server using these keys. If this fails, or not done, then password authentication will be attempted. Contains the file path specification for the file containing the client-side private key. If both 'public-key' and 'private-key' files are present, the client will attempt to connect to the server using these keys. If this fails, or not done, then password authentication will be attempted. Identifies the transport protocol that should be used. NETCONF over SSH. RFC 4742; RFC 6242 http://www.ietf.org/rfc/rfc4742.txt 0 NETCONF over TCP. If this enum is selected, then the default --ncport value is set to 2023, and the --protocols value is set to netconf1.0. The --password value will be ignored. tail-f confd 1 Common parameters used for XPath script constructs XPath expression string to evaluate. Use quotes if there are any whitespace or special characters in the expression. true Use the contents of the specified variable or external XML file as the conceptual document to apply the expression specified in the 'expr' parameter. If this parameter is missing then a dummy document will be used. This is only allowed if the expression only contains variable references or numeric/string constants. CLI Parameter Set for the NETCONF Client Application. true Specifies the yangcli command aliases file to use. Match mode to use for UrlPath name searches. Controls whether the yangcli command aliases will be saved at exit and loaded at startup. If true, the 'aliases-file' parameter will be used if it is set, or else the default aliases file will be used (~/.yuma/.yangcli_aliases), for loading and saving the yangcli command aliases. If false, the yangcli command aliases will only be stored and loaded manually with the aliases command. Controls whether partial keywords will be checked for interactive or script commands. By default, the first match for a partial keyword will be used if no definition is found for a command name or parameter name. Controls whether the command line history buffer will be saved at exit and loaded at startup. If true, the default history file will be used (~/.yuma/.yangcli_history) for loading and saving the history buffer. If false, the history buffer will only be stored and loaded manually with the history command. Controls whether any modules (except this one) will be automatically loaded upon startup or upon session startup with a server. If false, the 'mgrload' command must be used to explicitly load all the desired YANG modules. Controls whether the yangcli user variables will be saved at exit and loaded at startup. If true, the 'uservars-file' parameter will be used if set, or else the default user variables file will be used (~/.yuma/yangcli_uservars.xml), for loading and saving the yangcli user variables. If false, the yangcli user variables will only be stored and loaded manually with the uservars command. Specifies how invalid user input from the CLI will be handled when filling PDUs for remote operations. Silently accept invalid PDU and data model parameters. Intended for advanced server testing mode only. 0 Warn, but accept invalid PDU and data model parameters. 1 Prompt the user to keep the invalid value or re-enter the value. 2 Prompt the user to re-enter the invalid value. 3 If present, the interactive CLI will not be used. A script should be provided with the 'run-script' parameter, or a command provided with the 'run-command' parameter, or else the program will simply exit. If the auto-connect mode is enabled, then this will mode simply test if a NETCONF session can be established, then exit. Default module name string to use before 'netconf' and 'yangcli' are tried. The module prefix may need to be used for other modules. Controls how values are displayed during output to STDOUT or a log file. Plain identifier without any prefix format. 0 Plain text with XML prefix added format. 1 Plain text with module name as prefix added format. 2 XML format. 3 XML format, but no namespace (xmlns) attributes will be generated. 4 JSON format. 5 Allow RPC replies to be echoes to the log or STDOUT If 'true', <rpc-reply> messages containing data will be output to the log, if log-level is 'info' or higher. If 'false', <rpc-reply> messages containing data will not be output to the log, regardless of the value of log-level. The $$echo-replies system variable is derived from this parameter. Controls whether PDU parameters will be automatically sent to the server in the correct order. If false, the specified order will be used. If true, then canonical order will be used Controls whether the candidate or running configuration datastore will be used as the default edit target, when both are supported by the server. Force default edit target to be candidate. 0 Force default edit target to be running. 1 Match mode to use for UrlPath name searches. NETCONF port number to use. If not present, then port 830, followed by port 22, will be tried. User password to use for NETCONF sessions. If none, then user will be prompted before connecting. Contains the file path specification for the file containing the client-side private key. If both 'public-key' and 'private-key' files are present, the client will attempt to connect to the server using these keys. If this fails, or not done, then password authentication will be attempted. Contains the file path specification for the file containing the client-side public key. If both 'public-key' and 'private-key' files are present, the client will attempt to connect to the server using these keys. If this fails, or not done, then password authentication will be attempted. run-startup-mode run-command The specified command will be invoked upon startup. If the auto-connect parameters are provided, then a session will be established before running the command. run-script The specified script will be invoked upon startup. If the auto-connect parameters are provided, then a session will be established before running the script. If a quoted string is used, then any parameters after the script name will be passed to the script. IP address or DNS name of the NETCONF server target. Measure the round-trip time of each <rpc> request and <rpc-reply> at the session level. Echo the elapsed time value to screen if in interactive mode, as well as the log if the log is a file instead of stdout. The $$time-rpcs system variable is derived from this parameter. Number of seconds to wait for a response from the server before declaring a timeout. Zero means do not timeout at all. seconds Identifies the transport protocol that should be used. NETCONF over SSH. RFC 4742; RFC 6242 http://www.ietf.org/rfc/rfc4742.txt 0 NETCONF over TCP. If this enum is selected, then the default --ncport value is set to 2023, and the --protocols value is set to netconf1.0. The --password value will be ignored. tail-f confd 1 Specifies how file result variables will be written for XML files. Controls whether the XML preamble header will be written or not. User name to use for NETCONF sessions. Specifies the yangcli user variables file to use. Show or set a specific yangcli command alias. * Show all aliases in memory (same as aliases): yangcli> alias * Show one alias 'foo': yangcli> 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> alias s=show yangcli> alias getfoo='sget-config source=running /top/foo' * Aliases can override real commands, so be careful not to unintentionally alter real commands. yangcli> alias get-config='get-config source=running' alias_output_type__ var The alias command string. Manage the yangcli command aliases aliases_output_type__ alias-action show Show all the yangcli command aliases. clear Delete all the yangcli aliases from memory. load Load the yangcli command aliases from the specified file spec. The default aliases file will be loaded automatically at startup if the '--autoaliases' parameter is present. save Save the yangcli command aliases to the specified filespec. The default aliases file will be saved automatically at shutdown if the '--autoaliases' parameter is present. Change the current working directory. cd_output_type__ dir Directory path to use. true Connect to a NETCONF server. connect_output_type__ server User name to use for NETCONF sessions. true IP address or DNS name of the NETCONF server target. true User password to use for NETCONF sessions. If none, then user will be prompted before connecting. true NETCONF port number to use. If not present, then port 830, followed by port 22, will be tried. Number of seconds to wait for a response from the server before declaring a timeout. Zero means do not timeout at all. seconds Contains the file path specification for the file containing the client-side public key. If both 'public-key' and 'private-key' files are present, the client will attempt to connect to the server using these keys. If this fails, or not done, then password authentication will be attempted. Contains the file path specification for the file containing the client-side private key. If both 'public-key' and 'private-key' files are present, the client will attempt to connect to the server using these keys. If this fails, or not done, then password authentication will be attempted. Identifies the transport protocol that should be used. NETCONF over SSH. RFC 4742; RFC 6242 http://www.ietf.org/rfc/rfc4742.txt 0 NETCONF over TCP. If this enum is selected, then the default --ncport value is set to 2023, and the --protocols value is set to netconf1.0. The --password value will be ignored. tail-f confd 1 Create some NETCONF config data with the edit-config operation create_output_type__ target from true varref Use the contents of the specified variable as the content from-cli target-parm target XPath target object to fill. If prefixes are missing then the first match in any namespace will be used. Any prefix used must be the default prefix assigned to the desired YANG module. Prefix usage is optional. true urltarget URL encoded target object to fill. Encoding Rules: TBD. true If present, then prompt for leafs that are optional. If not, skip these objects. Contains a string representing the content to use for the filled variable. If a string is entered, then the target value being filled must be a leaf or leaf-list. If a variable is referenced, then it will be used as the content, if the target value being filled is a leaf or a leaf-list. If the target value is a complex object, then the referenced variable must also be a complex object of the same type. E.g., The global variable 'foo' would be specified as: value=$$foo The local variable 'bar' would be specified as: value=$bar An error will be reported if the global or local variable does not reference the same object type as the target parameter. Match mode to use for UrlPath name searches. Match mode to use for UrlPath name searches. Timeout to use seconds Delete some NETCONF config data with the edit-config operation delete_output_type__ target delete-target true target Xpath expression indicating the node which is going to be deleted. urltarget The URL path expression to use in the delete operation. 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. elif_output_type__ expr XPath expression string to evaluate. Use quotes if there are any whitespace or special characters in the expression. true Use the contents of the specified variable or external XML file as the conceptual document to apply the expression specified in the 'expr' parameter. If this parameter is missing then a dummy document will be used. This is only allowed if the expression only contains variable references or numeric/string constants. 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. else_output_type__ End an 'if' command block or a 'while' command block. If no block is in progress then an error will occur. end_output_type__ The XPath result, returned in a data element. The content will be a simple string for boolean, string, and number result types. The content will be zero or more child elements, in their proper namespaces, if the result is a node-set. Only the requested node(s) will be returned, not their entire path to the document root, like the get and get-config operations. An empty 'data' element will be returned if the result is an empty node-set. true 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' ... } eval_output_type__ expr XPath expression string to evaluate. Use quotes if there are any whitespace or special characters in the expression. true Use the contents of the specified variable or external XML file as the conceptual document to apply the expression specified in the 'expr' parameter. If this parameter is missing then a dummy document will be used. This is only allowed if the expression only contains variable references or numeric/string constants. Access the notification event log eventlog_output_type__ show eventlog-action show-case Show the specified number of event log buffer entries. -1 means show all entries. If the --full or --brief help-mode parameters are entered, then the output will be altered. Start at the specified event index number instead of the beginning of the event log. clear Clear the specified number of notification event log entries. The value zero means clear all the entries. The result of the fill operation. The name of the value node may not really be 'data'. If the 'target' or 'current-value' input parameters are used, then the name of the result node will be copied instead. The data type will be inherited from the 'target' or 'current_value' parameters, and not really be an 'anyxml' structure. YANG does have a data type that supports this feature. 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 fill_output_type__ target target-parm target XPath target object to fill. If prefixes are missing then the first match in any namespace will be used. Any prefix used must be the default prefix assigned to the desired YANG module. Prefix usage is optional. true urltarget URL encoded target object to fill. Encoding Rules: TBD. true If present, then prompt for leafs that are optional. If not, skip these objects. Contains a string representing the content to use for the filled variable. If a string is entered, then the target value being filled must be a leaf or leaf-list. If a variable is referenced, then it will be used as the content, if the target value being filled is a leaf or a leaf-list. If the target value is a complex object, then the referenced variable must also be a complex object of the same type. E.g., The global variable 'foo' would be specified as: value=$$foo The local variable 'bar' would be specified as: value=$bar An error will be reported if the global or local variable does not reference the same object type as the target parameter. Match mode to use for UrlPath name searches. Match mode to use for UrlPath name searches. 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. get-locks_output_type__ Total time to wait to retrieve all the locks needed to complete the get-locks command. A value of zero means to wait forever and not use a timeout value. seconds Retry interval to use if a lock is temporarily unavailable. The client will wait this number of seconds before attempting to get the current lock. seconds Indicates whether the locks obtained should be automatically released if an RPC operation fails (after the get-locks succeeds). Print the yangcli help text help_output_type__ command helptype command Show help for the specified command, also called an RPC method commands Show info for all local commands notification Show help for the specified notification object Show help for the specified object type Show help for the specified type Access the command line history buffer history_output_type__ show history-action show-case Show the specified number of history buffer entries. -1 means show all entries. clear Clear all the history buffer entries. load Load the command history buffer from the specified file spec. save Save the command history buffer in the specified filespec. 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. if_output_type__ expr XPath expression string to evaluate. Use quotes if there are any whitespace or special characters in the expression. true Use the contents of the specified variable or external XML file as the conceptual document to apply the expression specified in the 'expr' parameter. If this parameter is missing then a dummy document will be used. This is only allowed if the expression only contains variable references or numeric/string constants. Insert some NETCONF config data with the edit-config operation insert_output_type__ target from true varref Use the contents of the specified variable as the content from-cli target-parm target XPath target object to fill. If prefixes are missing then the first match in any namespace will be used. Any prefix used must be the default prefix assigned to the desired YANG module. Prefix usage is optional. true urltarget URL encoded target object to fill. Encoding Rules: TBD. true If present, then prompt for leafs that are optional. If not, skip these objects. Contains a string representing the content to use for the filled variable. If a string is entered, then the target value being filled must be a leaf or leaf-list. If a variable is referenced, then it will be used as the content, if the target value being filled is a leaf or a leaf-list. If the target value is a complex object, then the referenced variable must also be a complex object of the same type. E.g., The global variable 'foo' would be specified as: value=$$foo The local variable 'bar' would be specified as: value=$bar An error will be reported if the global or local variable does not reference the same object type as the target parameter. Match mode to use for UrlPath name searches. Match mode to use for UrlPath name searches. Timeout to use seconds The insert order that should be used. If the values 'before' or 'after' are selected, then the edit-target parameter must also be present. 0 1 2 3 The edit-config operation that should be used. 0 1 2 The value or key clause that should be used. This parameter should only be present if the order selected is 'before' or 'after'. For a leaf-list, the edit-target contains the value of the target leaf-list node within the configuration being edited. The new config will be inserted before or after this leaf-list node, depending on the order selected. E.g., edit-target='some leaf content'. For a list, the edit-target contains the key values of the target list node within the configuration being edited. The new config will be inserted before or after this list node, depending on the order selected. E.g., edit-target=[name='fred'][zipcode=90210]. List some NETCONF info. list_output_type__ listtype true commands List all local and remote commands files List all available data files. objects List all available top-level object names. oids List all available object identifiers. modules List all available local YANG files. scripts List all available script files. List only from this module, if specified. Write a message to the output log if the log-level is greater or equal to 'error'. log-error_output_type__ msg The formatted text string to write to the log. true Write a message to the output log if the log-level is greater or equal to 'warn'. log-warn_output_type__ msg The formatted text string to write to the log. true Write a message to the output log if the log-level is greater or equal to 'info'. log-info_output_type__ msg The formatted text string to write to the log. true Write a message to the output log if the log-level is greater or equal to 'debug'. log-debug_output_type__ msg The formatted text string to write to the log. true Merge some NETCONF config data with the edit-config operation merge_output_type__ target from true varref Use the contents of the specified variable as the content from-cli target-parm target XPath target object to fill. If prefixes are missing then the first match in any namespace will be used. Any prefix used must be the default prefix assigned to the desired YANG module. Prefix usage is optional. true urltarget URL encoded target object to fill. Encoding Rules: TBD. true If present, then prompt for leafs that are optional. If not, skip these objects. Contains a string representing the content to use for the filled variable. If a string is entered, then the target value being filled must be a leaf or leaf-list. If a variable is referenced, then it will be used as the content, if the target value being filled is a leaf or a leaf-list. If the target value is a complex object, then the referenced variable must also be a complex object of the same type. E.g., The global variable 'foo' would be specified as: value=$$foo The local variable 'bar' would be specified as: value=$bar An error will be reported if the global or local variable does not reference the same object type as the target parameter. Match mode to use for UrlPath name searches. Match mode to use for UrlPath name searches. Timeout to use seconds Load a module or other file into the client. Use the 'load' command to load a module into the server. mgrload_output_type__ module Module name to load true Module revision to load. Print the current working directory. pwd_output_type__ Create some NETCONF config data with the edit-config operation replace_output_type__ target from true varref Use the contents of the specified variable as the content from-cli target-parm target XPath target object to fill. If prefixes are missing then the first match in any namespace will be used. Any prefix used must be the default prefix assigned to the desired YANG module. Prefix usage is optional. true urltarget URL encoded target object to fill. Encoding Rules: TBD. true If present, then prompt for leafs that are optional. If not, skip these objects. Contains a string representing the content to use for the filled variable. If a string is entered, then the target value being filled must be a leaf or leaf-list. If a variable is referenced, then it will be used as the content, if the target value being filled is a leaf or a leaf-list. If the target value is a complex object, then the referenced variable must also be a complex object of the same type. E.g., The global variable 'foo' would be specified as: value=$$foo The local variable 'bar' would be specified as: value=$bar An error will be reported if the global or local variable does not reference the same object type as the target parameter. Match mode to use for UrlPath name searches. Match mode to use for UrlPath name searches. Timeout to use seconds Quit the yangcli application quit_output_type__ Recall the specified command line history buffer entry into the current command line. recall_output_type__ index Index [0..N] of the command line history entry to recall. true Unlock all the server databases that were previously locked with the get-locks command. release-locks_output_type__ Remove some NETCONF config data with the edit-config operation remove_output_type__ target Xpath expression indicating the node which is going to be deleted. true Internal command to run a script. run_output_type__ script script filespec to run true script parameter $1 script parameter $2 script parameter $3 script parameter $4 script parameter $5 script parameter $6 script parameter $7 script parameter $8 script parameter $9 Meta command to save configuration edits. save_output_type__ The data resulting from the retrieval operation. Get some NETCONF running config or state data with the get operation, using an optional subtree filter. sget_output_type__ target from true varref Use the contents of the specified variable as the content from-cli target-parm target XPath target object to fill. If prefixes are missing then the first match in any namespace will be used. Any prefix used must be the default prefix assigned to the desired YANG module. Prefix usage is optional. true urltarget URL encoded target object to fill. Encoding Rules: TBD. true If present, then prompt for leafs that are optional. If not, skip these objects. Contains a string representing the content to use for the filled variable. If a string is entered, then the target value being filled must be a leaf or leaf-list. If a variable is referenced, then it will be used as the content, if the target value being filled is a leaf or a leaf-list. If the target value is a complex object, then the referenced variable must also be a complex object of the same type. E.g., The global variable 'foo' would be specified as: value=$$foo The local variable 'bar' would be specified as: value=$bar An error will be reported if the global or local variable does not reference the same object type as the target parameter. Match mode to use for UrlPath name searches. Match mode to use for UrlPath name searches. If present, and the 'from-cli' option is used for input, then filling of mandatory nodes and key leafs will be skipped. Instead, the target object will be treated as a terminating select node in the filter element. The data resulting from the retrieval operation. Get some NETCONF config data with the get-config operation, using an optional subtree filter. sget-config_output_type__ target from true varref Use the contents of the specified variable as the content from-cli target-parm target XPath target object to fill. If prefixes are missing then the first match in any namespace will be used. Any prefix used must be the default prefix assigned to the desired YANG module. Prefix usage is optional. true urltarget URL encoded target object to fill. Encoding Rules: TBD. true If present, then prompt for leafs that are optional. If not, skip these objects. Contains a string representing the content to use for the filled variable. If a string is entered, then the target value being filled must be a leaf or leaf-list. If a variable is referenced, then it will be used as the content, if the target value being filled is a leaf or a leaf-list. If the target value is a complex object, then the referenced variable must also be a complex object of the same type. E.g., The global variable 'foo' would be specified as: value=$$foo The local variable 'bar' would be specified as: value=$bar An error will be reported if the global or local variable does not reference the same object type as the target parameter. Match mode to use for UrlPath name searches. Match mode to use for UrlPath name searches. If present, and the 'from-cli' option is used for input, then filling of mandatory nodes and key leafs will be skipped. Instead, the target object will be treated as a terminating select node in the filter element. Particular configuration to retrieve. config-source true candidate Only available if 'candidate' capability supported. running startup Only available if 'startup' capability supported. url URL pointing to config data. Only available if 'url' capability supported. Local show command for yangcli session info. show_output_type__ showtype true cli Show the yangcli CLI parameters. module Show full info for one module loaded within the current session. modules Show info for all modules loaded within the current session. local Show info for one local user variable. locals Show info for all local user variables. global Show full info for one global user variable. globals Show info for all global user variables. objects Show config database objects loaded within the current session. session Show the current session info, including the initial server capabilities for the session. system Show the read-only system environment variables and the read-write yangcli program variables. var Show info for one local or global variable. vars Show truncated info for all program variables version Show yangcli version info. Start a timer to do simple performance measurements. start-timer_output_type__ id The timer ID to use. Indicates whether the timer will be used if it is already running. If 'true', the timer will be restarted if it is already running. If 'false', an error will occur if the timer is already running. The elapsed time since the timer started. seconds Stop a timer and output the delta value. stop-timer_output_type__ id The timer ID to use. Echo the elapsed time value to screen if in interactive mode, as well as the log if the log is a file instead of stdout. 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. while_output_type__ expr XPath expression string to evaluate. Use quotes if there are any whitespace or special characters in the expression. true Use the contents of the specified variable or external XML file as the conceptual document to apply the expression specified in the 'expr' parameter. If this parameter is missing then a dummy document will be used. This is only allowed if the expression only contains variable references or numeric/string constants. Set a maximum number of loops that can be iterated for this while command. The value zero means that no maximum will be enforced. Use this mode with caution. The data resulting from the retrieval operation. Get some NETCONF running config or state data with the get operation, using an optional XPath filter. xget_output_type__ select from true varref Use the contents of the specified variable as the content select The XPath expression to use in the retrieval operation. The string may only contain single quotes, which are required for string literals. The entire string will be inserted into a double-quoted string, within the get-config PDU. Character entities will be inserted as needed to maintain well-formed XML. urltarget The URL path expression to use in the retrieval operation. Timeout to use seconds Match mode to use for UrlPath name searches. Match mode to use for UrlPath name searches. The data resulting from the retrieval operation. Get some NETCONF config data with the get-config operation, using an optional XPath filter. xget-config_output_type__ select from true varref Use the contents of the specified variable as the content select The XPath expression to use in the retrieval operation. The string may only contain single quotes, which are required for string literals. The entire string will be inserted into a double-quoted string, within the get-config PDU. Character entities will be inserted as needed to maintain well-formed XML. urltarget The URL path expression to use in the retrieval operation. Timeout to use seconds Match mode to use for UrlPath name searches. Match mode to use for UrlPath name searches. Particular configuration to retrieve. config-source true candidate Only available if 'candidate' capability supported. running startup Only available if 'startup' capability supported. url URL pointing to config data. Only available if 'url' capability supported. Delete a specific yangcli command alias. * Delete one alias 'foo': yangcli> unset foo unset_output_type__ Name of the yangcli command alias to delete. true Manage the yangcli user variables uservars_output_type__ uservars-action true clear Delete all the yangcli user variables from memory. load Load the yangcli user variables from the specified XML file spec. The default user variables file will be loaded automatically at startup if the '--autouservars' parameter is present. The container 'vars' data structure represents the format of the XML file expected. save Save the yangcli user variables to the specified filespec. The default user variables file will be saved automatically at shutdown if the '--autouservars' parameter is present. The container 'vars' data structure represents the format of the XML file that will be written. Represents all saved yangcli user variables true Data structure to save one yangcli user variable system Name of the user variable Target variable if variable represents a node from a datastore. User variable type; only 'global' variables can be saved in the yangcli uservars file. Node value renamed to 'value' since YANG requires each node to have a consistent name.