3  CLI Reference

The YumaPro programs uses command line interface (CLI) parameters to control program behavior.

Many parameters are supported by more than one program, such as --log.

The following sections document all the YumaPro CLI parameters, in alphabetical order.

3.1  --aliases-file

The --aliases-file parameter specifies the yangcli-pro command aliases file specification to use.

 

--aliases-file parameter

 

Syntax

string

Default:

$HOME/.yumapro/.yangcli_pro_aliases

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \

    --aliases-file=~/myalaises

 

3.2  --alt-names

The --alt-names parameter controls whether alternative names are searched when processing a UrlPath search.

 

--alt-names parameter

 

Syntax

boolean (true or false)

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --alt-names=false

 

 

 

 

 

 

 

 

3.3  --ask-password

The --ask-password parameter controls whether the user will be prompted for a password for the “connect” command. This might be useful if keys are used instead for SSH authentication.  If 'true' then the --no-password parameter can still be used in the connect command instead of providing a password.

 

--ask-password parameter

 

Syntax

boolean (true or false)

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --ask-password=false

 

3.4  --auto-discard-changes

The --auto-discard-changes parameter controls whether discard-change will be automatically sent on the errors of the edit and save mode.

 

--auto-discard-changes parameter

 

Syntax

boolean (true or false)

Default:

FALSE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \

   --auto-discard-changes=true

 

3.5  --auto-keepalive

The --auto-keepalive parameter Controls whether kepalive messages will be automatically sent on a connected session.

If 'true', keepalive message is sent every keepalive-interval.

If 'false', then keepalive message will not be sent..

This parameter is NOT IMPLEMENTED.  IT IS IGNORED.

 

--auto-keepalive parameter

 

Syntax

boolean (true or false)

Default:

FALSE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --auto-keepalive=true

 

3.6  --auto-reconnect

The --auto-reconnect parameter controls whether yangcli-pro will try to reconnect to the server If the session gets dropped by the server.

 

--auto-reconnect parameter

 

Syntax

boolean (true or false)

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --auto-reconnect=false

 

3.7  --auto-reconnect-interval

The --auto-reconnect-interval parameter indicates the number of seconds yangcli-pro will wait to re-establish a connection if a session is dropped and the server becomes unreachable.  The default is 10 seconds.

--auto-reconnect-interval parameter

 

Syntax

uint16

Default:

10

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --auto-reconnect-interval =15

 

3.8  --auto-reconnect-max

The --auto-reconnect-max parameter controls the number of times to retry the connection. Zero means no limit, otherwise re-connect attempts will stop after this number of failures. The default is 5 times.

 

--auto-reconnect-max parameter

 

Syntax

uint16

Default:

5

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --auto-reconnect-max=3

 

3.9  --autoaliases

The --autoaliases parameter controls automatic loading and saving of the command aliases file.

If 'true', then aliases will be loaded and saved automatically.

If 'false', then aliases must be loaded and saved manually with the 'aliases' command.

 

--autoaliases parameter

 

Syntax

boolean (true or false)

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --autoaliases=false

 

3.10  --autocomp

The --autocomp parameter controls automatic completion of command and parameter names.

If true, then the program will attempt to find a partial match by comparing only the number of characters entered.  For example '--log-l=debug' is the same as '--log-level=debug'.

If 'false', then command and parameter names must match exactly.

--autocomp parameter

 

Syntax

boolean (true or false)

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --autocomp=false

 

3.11  --autoconfig

The --autoconfig parameter controls whether the running configuration will be retrieved automatically for active sessions. By default, the running config will be retrieved and maintained so it can be compared and used for command tab completion.

If true, then the program will attempt to retrieve and maintain a shadow configuration for each session, using the <get-config> NETCONF operation. If 'false', then automatic shadow configuration handling will not be done.

 

--autoconfig parameter

 

Syntax

boolean (true or false)

Default:

FALSE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --autoconfig=true

 

 

3.12  --autoconfig-conf-mode

The --autoconfig-conf-mode parameter controls whether the running configuration will be retrieved automatically for active sessions in config-mode.

 

--autoconfig-conf-mode parameter

 

Syntax

boolean (true or false)

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \
  --autoconfig-conf-mode=false

 

3.13  --autodevices

The --autodevices parameter controls whether the saved devices will be loaded into memory at startup and saved to file at exit.

If true, the default device-cfg file will be used (~/.yumapro/.yangcli_pro_devices.conf) for loading and saving the configured devices in memory.

If false, the configured devices will only be stored and loaded manually with the devices-cfg command.

 

--autodevices parameter

 

Syntax

boolean (true or false)

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --autodevices=false

 

3.14  --autohistory

The --autohistory parameter controls automatic loading and saving of the command line history buffer in the yangcli-pro program..

If true, then when the program starts, the default command line history buffer will be loaded, and the previous set of commands will be available with the history and recall commands. The --history-file parameter specifies which file is used to load and save the command line history.

If 'false', then the command line history buffer will not be loaded and saved automatically.

The default location for this file is ~/.yumapro/.yangcli_pro_history.

 

--autohistory parameter

 

Syntax

boolean (true or false)

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --autohistory=false

 

3.15  --autoload

The --autoload parameter controls automatic loading of YANG modules, as needed.

If true, then the program will attempt to find a needed YANG module.

If 'false', then YANG modules must be loaded manually.

 

--autoload parameter

 

Syntax

boolean (true or false)

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --autoload=false

 

 

3.16  --autoload-cache

The --autoload-cache parameter controls whether the modules retrieved with the <get-schema> operation are cached for use by the running instance of yangcli-pro.

 

--autoload-cache parameter

 

Syntax

boolean (true or false)

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --autoload=false

 

3.17  --autoload-get

The --autoload-get parameter controls automatic loading of YANG modules, as needed.

If true, then the program will attempt to find a needed YANG module.

If 'false', then YANG modules must be loaded manually.

 

--autoload-get parameter

 

Syntax

boolean (true or false)

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --autoload=false

 

3.18  --autoload-save-cache

The --autoload-save-cache parameter controls whether the modules held in the YANG module cache, are saved when yangcli-pro exits, as needed.

If TRUE, then the YANG modules that are cached will be saved when yangcli-pro exits.

If FALSE, then the YANG modules that are cached will not be saved when yangcli-pro exits.

 

--autoload-save-cache parameter

 

Syntax

boolean (true or false)

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \
  --autoload-save-cache=false

 

 

3.19  --autonotif

The --autonotif parameter controls automatic creation of a notification subscription, if the server supports the :notification and :interleave capabilities.

If 'true', then the program will attempt to start a notification subscription if the server advertises support, using the <create-subscription> NETCONF operation.

If 'false', then notification subscriptions must be started manually.

 

--autonotif parameter

 

Syntax

boolean (true or false)

Default:

FALSE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --autonotif=true

 

3.20  --autonvsave

The --autonvsave parameter controls whether the 'save' and 'apply' commands will NV-save the configuration changes or not. If the server advertises the :startup capability and this variable is set to 'false', then the final step to save running to startup will not be done.  The 'nvsave' command can be used to  manually save the running datastore to non-volatile memory (startup datastore). If this parameter is set to 'true' the final step of saving the running datastore to the startup datastore will be done.

 

--autonvsave parameter

 

Syntax

boolean (true or false)

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --autonvsave=false

 

 

3.21  --autoschemaservers

The --autoschemaservers controls whether the saved schema servers will be loaded into memory at startup and saved to file at exit. If true, the default schemaserver-cfg file will be used (~/.yumapro/.yangcli_pro_schemaservers .conf) for loading and saving the configured schema servers in memory. If false, the configured schema servers will only be stored and loaded manually with the schemaserver-cfg command.

--autoschemaservers parameter

 

Syntax

boolean (true or false)

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --autoschemaservers=false

 

3.22  --autosessions

The --autosessions parameter controls whether the saved sessions will be loaded into memory at startup and saved to file at exit.

If true, the default session-cfg file will be used (~/.yumapro/.yangcli_pro_sessions.conf) for loading and saving the configured sessions in memory.

If false, the configured sessions will only be stored and loaded manually with the sessions-cfg command.

 

--autosessions parameter

 

Syntax

boolean (true or false)

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --autosessions=false

 

3.23  --autotest

The --autotest parameter controls whether the saved test suites will be loaded into memory at startup and saved to file at exit.

If true, the default test-suite-cfg file will be used (~/.yumapro/.yangcli_pro_tests.conf) for loading and saving the configured test-suites in memory.

If false, the configured test-suites will only be stored and loaded manually with the test-suite command.

 

--autotest parameter

 

Syntax

boolean (true or false)

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --autotest=false

 

3.24  --autousers

The --autousers parameter controls whether the saved sessions will be loaded into memory at startup and saved to file at exit.

If true, the default users-cfg file will be used (~/.yumapro/.yangcli_pro_users.conf) for loading and saving the configured users in memory.

If false, the configured sessions will only be stored and loaded manually with the users-cfg command.

 

--autousers parameter

 

Syntax

boolean (true or false)

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --autousers=false

 

3.25  --autouservars

The --autouservars parameter controls automatic loading of global user variables.

If 'true', then the global user variables will be automatically loaded and saved.

If 'false', then the global user variables must be loaded and saved manually with the 'uservars' command.

 

--autouservars parameter

 

Syntax

boolean (true or false)

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --autouservars=false

 

 

3.26  --bad-data

The --bad-data parameter controls how invalid parameter input is handled by the program.

 

--bad-data parameter

 

Syntax

enumeration:
 ignore
 warn
 check
 error

Default:

check

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --bad-data=warn

 

3.27  --batch-mode

The --batch-mode parameter specifies that the interactive CLI will not be used.

Instead, if a script is provided with the 'run-script' parameter, or a command provided with the 'run-command' parameter, then it will be executed automatically before the program exits.  This mode can be used to invoke NETCONF commands from Unix shell scripts.

 

--batch-mode parameter

 

Syntax

empty

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --batch-mode \
 --run-script=~/run-tests

 

 

3.28  --binary-display-maxlen

The --binary-display-maxlen parameter specifies the maximum number of bytes to display when dumping          the contents of a binary value. Normally a message will be displayed showing the name and length.

If this parameter is set to a value greater than zero then a standard 8-byte per line hex dump of the binary type will also be displayed for a maximum number  of bytes set by this parameter.

 

 

--binary-display-maxlen parameter

 

Syntax

uint32

Default:

0

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro, netconfd-pro

Example:

yangcli-pro \
  --binary-display-maxlen=100

 

3.29  --break-key-mode

The --break-key-mode parameter specifies the bahavior when the break key is pressedduring a command. The default mode is 'program' to maintain backward compatibility.

        program

          Break key will cause the program to exit no matter what mode or state the program is in at the moment.

        command

          Break key will cause the current command in the current session to be terminated.

          If no command is in progress, or currently in config mode or enable mode, then the break key will have no affect.

 

--break-key-mode parameter

 

Syntax

enum (program | control)

Default:

program

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \
   --break-key-mode=command

 

 

3.30  --callhome-address

The --callhome-address parameter specifies the IP address that should be used to listen for callhome connections. Ignored if callhome-enabled  is false.

 

--callhome-address parameter

 

Syntax

Inet:ip-address

Default:

0.0.0.0

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \
   --callhome-address=192.168.0.40

 

 

3.31  --callhome-enabled

The --callhome-enabled parameter enables the Call Home protocol. If true, then yangcli-pro will listen for SSH CallHome connections on the socket identified by the callhome-address and callhome-port parameters.

 

--callhome-enabled parameter

 

Syntax

boolean

Default:

false

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \
   --callhome-enabled=true

 

 

3.32  --callhome-port

The --callhome-port parameter specifies the TCP port number that should be used to listen for NETCONF over SSH callhome connections. Ignored if callhome-enabled  is false.

 

--callhome-port parameter

 

Syntax

Inet:port-number

Default:

4334

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \
   --callhome-port=8400

 

3.33  --callhome-tls-port

The --callhome-tls-port parameter specifies the TCP port number that should be used to listen for NETCONF over TLS callhome connections. Ignored if callhome-enabled  is false.

 

--callhome-tls-port parameter

 

Syntax

Inet:port-number

Default:

4335

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \
   --callhome-tls-port=8401

 

3.34  --callhome-user

The --callhome-user parameter specifies the name of a configured user entry that should be used as the default user for callhome sessions, if no saved session entry is found matching  the server IP address.  Will be ignored if the user            is not currently configured.

 

--callhome-user parameter

 

Syntax

string

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \
   --callhome-user=chuser1

 

 

Note that the user value is the name of a user-cfg entry, which has to be set up in advance for this parameter to have any effect.

 

Example user-cfg command for user “chuser1”

 

> user-cfg create chuser1 user-name=fred password=secret1

 

 

3.35  --check-output

The --check-output parameter specifies whether <rpc> messages about to be sent to a remote server should be validated against the YANG schema for the specific RPC operation.

If true, then yangcli-pro will validate remote commands against the YANG definition for the rpc/input node. This checks the operation parameters about to be sent to a server session.

Note that validation of the contents of a <config> element is not done.

This CLI parameter is also the $$check-output global parameter.";

 

 

--check-output parameter

 

Syntax

boolean

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --check-output=false

 

3.36  --check-output-error

The --check-output-error parameter specifies whether validation errors detected in <rpc> messages about to be sent to a remote server should be treated as warnings or errors.

If 'true', then errors found during the check-output validation tests will be treated as errors, causing the <rpc> about to be sent to fail. If 'false', then errors found during the check-output validation tests will be treated as warnings.

This CLI parameter is also the $$check-output-error global parameter.";

 

--check-output-error parameter

 

Syntax

boolean

Default:

FALSE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --check-output-error=true

 

3.37  --check-replies

The --check-replies parameter specifies whether <rpc-reply> messages received from a remote server should be validated against the YANG schema for the specific RPC operation.

If true, then yangcli-pro will validate remote commands against the YANG definition for the rpc/output node. If the “output” section is missing or empty, then the <rpc-reply> will be checked to make sure it contains either <ok> or 1 or more <rpc-error> elements.

This checks the parameters in the <rpc-reply> sent from a server session.

Note that validation of the contents of a <config> element is not done.

This CLI parameter is also the $$check-replies global parameter.

 

--check-replies parameter

 

Syntax

boolean

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --check-replies=false

 

3.38  --check-replies-error

The --check-replies-error parameter specifies whether validation errors detected in <rpc-reply> messages received from a remote server should be treated as warnings or errors.

If 'true', then errors found during the check-replies validation tests will be treated as errors, causing the <rpc-reply> about to be processed to be rejected instead.

If 'false', then errors found during the check-replies validation tests will be treated as warnings.

This CLI parameter is also the $$check-replies-error global parameter.";

 

--check-replies-error parameter

 

Syntax

boolean

Default:

FALSE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \
  --check-replies-error=true

 

3.39  --config

The --config parameter specifies the name of a YumaPro configuration file that contains more parameters to process, in addition to the CLI parameters.

Refer to the 'Configuration Files' section for details on the format of this file.

 

--config parameter

 

Syntax

string: complete file specification of the text file to parse for more parameters.

Default:

/etc/yumapro/<program-name>.conf

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro
yangdiff-pro
yangdump-pro

Example:

yangcli-pro testmod \
 --config=~/testconf.conf

 

3.40  --config-autosave

The --config-autosave parameter controls how edits in config term mode are saved to NV-storage if the server supports the :startup capability.  If 'true',  automatically copy running to startup when an edit is applied. If 'false', no automatically copy from running to startup when an edit is applied. The user will enter 'save' or 'copy-config' manually once config term mode is exited.

--config-autosave parameter

 

Syntax

boolean

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yancli-pro

Example:

yangcli-pro --config-autosave=true

 

3.41  --config-commit-mode

The --config-commit-mode parameter controls how edits will be commited in configuration mode.

"If 'true' then edits done in config mode will be made to the candidate datastore if possible. The edits will not be committed to the running datastore automatically.  Instead, <config-commit> command in config mode, or <commit> operation in normal mode is required to activate the edits in the server. If 'false' then edits done in config mode will be committed to the running datastore after each 'apply' or 'exit' command in config mode.";

The default configuration commit mode is 'false'.

--config-commit-mode parameter

 

Syntax

boolean

Default:

false

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --config-commit-mode=true

 

 

3.42  --config-edit-mode

The --config-edit-mode parameter controls how edits will be applied in configuration mode.

There are 4 possible editing modes:

The default configuration editing mode is 'level'. Note that the 'apply' command can be used even if the value of this parameter is not 'manual'.

--config-edit-mode parameter

 

Syntax

enum:
 line
 level

  manual

Default:

level

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --config-edit-mode=line

 

3.43  --datapath

The --datapath parameter specifies the directory search path to use while searching for data files.  It consists of a colon (':') separated list of path specifications, commonly found in Unix, such as the $PATH environment variable.

This parameter overrides the $YUMAPRO_DATAPATH environment variable, if it is present.

 

--datapath parameter

 

Syntax

string: list of directory specifications

Default:

$YUMAPRO_DATAPATH environment variable

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro
yangdiff-pro
yangdump-pro

Example:

yangcli-pro \
 --datapath=”~/work2:~/data”

 

3.44  --default-module

The --default-module parameter specifies the module to search for identifiers, after the netconf and ncx modules have been checked.  This allows a specific module to match identifier names first, before all modules are searched at once.  This can avoid a collision if the same identifier value is used in more than one module.

 

--default-module parameter

 

Syntax

string: module name without any path or file extension included.

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --default-module=testmod

 

 

3.45  --deviation

The --deviation parameter is a leaf-list of modules that should be loaded automatically when the program starts, as a deviation module.  In this mode, only the deviation statements are parsed and then made available later when the module that contains the objects being deviated is parsed.

The deviations must be known to the parser before the target module is parsed.

This parameter is used to identify any modules that have deviation statements for the set of modules being parsed (e.g., --module and --subtree parameters).

A module can be listed with both the --module and --deviation parameters, but that is not needed unless the module contains external deviations.  If the module only contains deviations for objects in the same module, then the --deviation parameter does not need to be used.

The program will attempt to load each module in deviation parsing mode, in the order the parameters are entered.

For the netconfd-pro program, If any modules have fatal errors then the program will terminate.

For the yangdump-pro and yangcli-pro programs, each module will be processed as requested.

 

--deviation parameter

 

Syntax

module name or filespec

Default:

none

Min Allowed:

0

Max Allowed:

unlimited

Supported by:

netconfd-pro
yangcli-pro
yangdump-pro

Example:

yangcli-pro \
 --module=test1 \
 --deviation=test1_deviations

 

3.46  --disable-command

The --disable-command parameter specifies a top-level command that should be disabled and not visible or available to a user. If the value does not contain a module name prefix, then the command will be disabled in all modules.

 

--disable-command parameter

 

Syntax

nt:NcxIdentifier

Default:

none

Min Allowed:

0

Max Allowed:

unlimited

Supported by:

yangcli-pro

Example:

yangcli-pro \
 --disable-command=nc:delete-config

 

3.47  --display-mode

The --display-mode parameter controls how data is displayed in the program.

The qualified names (identifiers, idenitityref, XPath) within a text configuration can be generated several ways.  This is needed because sibling nodes in different XML namespaces can have the same name.

--display-mode values

 

enum value

description

example

plain

no prefix, just local-name

sysBootError

prefix

XML prefix and local-name

sys:sysBootError

module

module name and local name

system:sysBootError

xml

XML format

<sysBootError xmlns=”foo”>

xml-nons

XML format without namespace (xmlns) attributes

<sysBootError>

json

JSON format

{ “sysBootError” : “blah” }

 

When saving configuration files in non-volatile storage, then it is suggested that only 'module' or 'xml' modes be used, since these are the only deterministic modes.

The set of XML prefixes in use at any one time is not persistent, and cannot be relied upon, unless the namespace declarations are saved (xml mode) or the module names are saved (module mode).

 

display-mode parameter

 

Syntax

enumeration:
 plain
 prefix
 module
 xml
 xml-nons
 json

Default:

plain

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --display-mode=module

 

3.48  --echo-notif-loglevel

The --echo-notif-loglevel parameter controls how unregistered notifications are echoed when notification messages are received. If the --echo-notifs parameter is true, then this parameter controls the logging debug level needed for notifications to be printed,  If --echo-notifs is 'false' then this parameter has no affect.

 

Only notifications other than <sys-config-change> and <sysConfigChange> are echoed.  Those notifications are used to maintain shadow configurations.

If the --log-level is set to the same value or higher as this parameter, then the full notification message will be echoed.

If the --log-level is set to one level lower than this parameter, then a 1 line notification summary message will be echoed.  For example, if --log-level=info and --echo-nofits=true and --echo-notif-loglevel=debug, then a one line summary will be printed for received notifications.

 

--echo-notif-loglevel parameter

 

Syntax

enum: (same as log-level)

Default:

debug

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \
 --echo-notif-loglevel=info

 

3.49  --echo-notifs

The --echo-notifs parameter controls whether unregistered notifications are echoed when notification messages are received.

Only notifications other than <sys-config-change> and <sysConfigChange> are echoed.  Those notifications are used to maintain shadow configurations.

 

--echo-notifs parameter

 

Syntax

boolean

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --echo-notifs=false

 

3.50  --echo-replies

The --echo-replies parameter controls whether <rpc-reply> messages are echoed when they are received.

If 'true' then replies with data will be displayed.  If 'false' then they will not be displayed.  Note that this parameter does not affect error replies (messages with <rpc-error> elements in them).

 

--echo-replies parameter

 

Syntax

boolean

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --echo-replies=false

 

3.51  --encoding

The --encoding parameter identifies the desired encoding format for RESTCONF request messages.

The supported values are ‘xml’ and ‘json’.

 

--encoding parameter

 

Syntax

enum (xml | json)

Default:

xml

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --encoding=json

 

3.52  --entry-point

The --entry-point parameter identifies the RESTCONF entry point. Use this string instead of retrieving the XRD from the RESTCONF server to discover the entry point.

 

--encoding parameter

 

Syntax

string

Default:

/restconf

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \
  --entry-point=/api/restconf

 

 

3.53  --feature-disable

The --feature-disable parameter directs all programs to disable a specific feature.

This parameter is a formatted string containing a module name, followed by a colon ':', followed by a feature name:

 

 

test:feature1

 

 

It is an error if a --feature-enable and --feature-disable parameter specify the same feature.

Parameters for unknown features will be ignored.

--feature-disable parameter

 

Syntax

formatted string (module:feature

Default:

none

Min Allowed:

0

Max Allowed:

unlimited

Supported by:

yangcli-pro
yangdiff-pro
yangdump-pro
netconfd-pro

Example:

yangcli-pro \

   --feature-disable=test:feature1

 

3.54  --feature-enable

The --feature-enable parameter directs all programs to enable a specific feature.

This parameter is a formatted string containing a module name, followed by a colon ':', followed by a feature name:

 

 

test:feature1

 

 

It is an error if a --feature-disable and --feature-enable parameter specify the same feature.

Parameters for unknown features will be ignored.

 

--feature-enable parameter

 

Syntax

formatted string (module:feature

Default:

none

Min Allowed:

0

Max Allowed:

unlimited

Supported by:

yangcli-pro
yangdiff-pro
yangdump-pro
netconfd-pro

Example:

yangcli-pro \

    --feature-enable=test:feature1

 

3.55  --feature-enable-default

The --feature-enable-default parameter controls how yangdump-pro will generate C code for YANG features by default.

If 'true', then by default, features will be enabled.

If 'false', then by default, features will be disabled.

If a --feature-enable or --feature-disable parameter is present for a specific feature, then this parameter will be ignored for that feature.

 

--feature-enable-default parameter

 

Syntax

boolean (true or false)

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro
yangdiff-pro
yangdump-pro
netconfd-pro

Example:

yangcli-pro \
  --feature-enable-default=false

 

3.56  --fill-optional

The --fill-optional parameter controls the default for the --optional parameter that can be passed to many interactive commands such as 'fill' or 'create'.

If 'true' then the user will be prompted to enter optional nodes while filling YANG datastore content.

If 'false' then the user will not be prompted to enter optional nodes while filling YANG datastore content.

 

--fill-optional parameter

 

Syntax

boolean (true or false)

Default:

FALSE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

Yangcli-pro --fill-optional=true

 

3.57  --fixorder

The --fixorder parameter controls whether PDU parameters will be automatically sent in NETCONF PDUs in the correct order.

If 'true', the schema-defined, canonical order will be used.

If 'false', the specified order that parameters are entered will be used for the PDU order as well.

 

--fixorder parameter

 

Syntax

boolean (true or false)

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --fixorder=false

 

3.58  --force-target

The --force-target parameter controls whether the candidate or running configuration datastore will be used as the default edit target, when both are supported by the server.

--force-target parameter

 

Syntax

enum (candidate or running)

Default:

candidate

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --force-target=running

 

3.59  --help

The --help parameter causes program help text to be printed, and then the program will exit instead of running as normal.

This parameter can be combined with the --help-mode parameter to control the verbosity of the help text.  Use --brief for less, and --full for more than the normal verbosity.

This parameter can be combined with the --version parameter in all programs.  It can also be combined with the --show-errors parameter in yangdump-pro.

The program configuration parameters will be displayed in alphabetical order, not in schema order.

 

--help parameter

 

Syntax

empty

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro
yangdiff-pro
yangdump-pro

Example:

yangcli-pro --help

 

3.60  --help-mode

The --help-mode parameter is used to control the amount of detail printed when help text is requested in some command.  It is always used with another command, and makes no sense by itself.  It is ignored unless used with the --help parameter.

--help-mode parameter

 

Syntax

choice of 3 empty leafs

  --brief
 --normal
 --full

Default:

normal

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro
yangdiff-pro
yangdump-pro

Example:

yangcli-pro --help --help-mode=full

 

 

3.61  --help-width

The --help-width parameter specifies the line width to use when displaying help text for the help key '?' within config term mode. This help mode aligns the description to the right of the widest object node name being displayed.

If the 'help' extension is used, then that text is displayed in its entirety. Otherwise the total line width will be limited to this help-width value.

 

--help-width parameter

 

Syntax

uint16 (80 .. 511)

Default:

80

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

Yangcli-pro --help-width=130

 

3.62  --history-file

The --history-file parameter specifies the file location for the libtecla command line history file used if --autohistory is 'true'. This file will be created if if does not exist and the --autohistory parameter is 'true'.

 

--history-file parameter

 

Syntax

string

Default:

~/.yumapro/.yangcli_pro_history

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \
  --history-file=~/my-history.txt

 

3.63  --home

The --home parameter over-rides the $HOME environment variable, if it is set.  File searches that use the user's home directory will use this path specification instead.  

 

--home parameter

 

Syntax

string: pathspec

Default:

$HOME environment value

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro
yangdiff-pro
yangdump-pro

Example:

yangcli-pro --home=~/testmodules

 

3.64  --ignore-missing-vars

The --ignore-missing-vars parameter specifies how missing variable errors in data templates are handled. This parameter has no affect unless the 'use-data-templates' parameter  is 'true'.

If 'true', then variable expressions that contain references to missing variables will not cause a parsing error. Instead, an empty string will be used or the value of a missing variable.

If 'false', then variable expressions that contain references to missing variables will cause a parsing error.

 

--ignore-missing-vars parameter

 

Syntax

boolean

Default:

FALSE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \
  --ignore-missing-vars=true

 

3.65  --indent

The --indent parameter specifies the number of spaces that will be used to add to the indentation level, each time a child node is printed during program operation.

--indent parameter

 

Syntax

uint32 (0 .. 9)

Default:

2

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro
yangdiff-pro
yangdump-pro

Example:

yangcli-pro --indent=4

 

3.66  --insecure-ok

The --insecure-ok parameter specifies if insecure NETCONF over TLS should be allowed. If true then X.509 certificates will be accepted even if they cannot be verified. Used for debugging only!

This parameter is only available if the image was built with the DEBUG=1 parameter.

 

--insecure-ok parameter

 

Syntax

boolean

Default:

FALSE

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro

Example:

yangcli-pro --insecure-ok=true

3.67  --keepalive-interval

The --keepalive-interval parameter Specifies the time interval, in seconds, between keepalive messages sent from a session. This value is only used if 'auto-keepalive' is true.  NOT IMPLEMENTED. IGNORED BY PROGRAM.

 

-- keepalive-interval parameter

 

Syntax

uint32 (1 .. 3600)

Default:

4

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --keepalive-interval=10

 

3.68  --log

The --log parameter specifies a file name to be used for logging program messages, instead of STDOUT.  It can be used with the optional parameters below to control how the log file is written. (See also --log-syslog which directs message output to a syslog daemon, and the --log-console parameter which duplicates log output via STDOUT.

 

--log parameter

 

Syntax

string: log file specification

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro
yangdiff-pro
yangdump-pro

Example:

netconfd-pro --log=~/server.log&

 

3.69  --log-append

The --log-append parameter specifies that the existing log file (if any) should be appended , instead of deleted.  It is ignored unless the --log parameter is present.

 

--log-append parameter

 

Syntax

empty

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro
yangdiff-pro
yangdump-pro

Example:

netconfd-pro --log-append \
 --log=~/server.log&

 

3.70  --log-backtrace

The --log-backtrace parameter specifies that stack frame trace information be appended to selected log messages. By default, this information will be included in all enabled output streams (STDOUT, STDERR, log file, and/or syslog). Such output may be further restricted by inclusion of any of the --log-backtrace-xxx commands below.

 

--log-backtrace parameter

 

Syntax

Max frame count: 0..200

Default:

0 means use internal default (20)

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro

Example:

netconfd-pro --log-backtrace=0

 

3.71  --log-backtrace-detail

The --log-backtrace-detail adds compiler/OS dependent information to the output of --log-backtrace.

 

--log-backtrace-detail parameter

 

Syntax

empty

Default:

  none

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro

Example:

netconfd-pro --log-backtrace=0 \

  --log-backtrace-detail

 

 

3.72  --log-backtrace-level

The --log-backtrace-level parameter specifies that stack frame trace information be appended only to selected log message levels (see --log-level).

 

--log-backtrace-level parameter

 

Syntax

Enumeration:
error
warn
info
debug
debug2
debug3
debug4

One of more enumeration(s) may be specified by enclosing the string in double quotes ('”') and separating each member with a space.

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro

Example:

Netconfd-pro --log-backtrace=0 \

  --log-backtrace-level=”error debug”

 

3.73  --log-backtrace-stream

The --log-backtrace-stream parameter specifies that stack frame trace information will be limited to output streams specified by the argument list. Possible arguments include logfile, stdout, stderr, syslog, and vendor.

 

--log-backtrace-stream parameter

 

Syntax

Enumeration:
logfile

stdout

stderr

syslog

vendor

One or more enumeration(s) may be specified by enclosing the string in double quotes ('”') and separating each member with a space.

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro

Example:

netconfd-pro --log-syslog         \

  --log=server.log                \

  --log-backtrace=0               \

  --log-backtrace-stream=”logfile”

 

3.74  --log-console

The --log-console parameter directs that log output will be be sent to STDOUT, after being sent to the log file and/or local syslog daemon. (This assumes that --log and/or  --log-syslog are present).

 

--log-console parameter

 

Syntax

empty

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro

Example:

Netconfd-pro --log=file \

  --log-syslog --log-console &

 

 

3.75  --log-header

The --log-header parameter specifies that additional information (level/date/time) will be included in the log stream output. Possible arguments to this command include custom (add date/time/level info) and localtime (express date/time in local terms).

 

--log-header parameter

 

Syntax

Enumeration:
custom

localtime

One or more enumeration(s) may be specified by enclosing the string in double quotes ('”') and separating each member with a space.

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro

Example:

netconfd-pro --log-append \
 --log=~/server.log      \

  --log-header=”custom localtime”&

 

3.76  --log-level

The --log-level parameter controls the verbosity level of messages printed to the log file or STDOUT, if no log file is specified.

The log levels are incremental, meaning that each higher level includes everything from the previous level, plus additional messages.

There are 7 settings that can be used:

 

 

--log-level parameter

 

Syntax

enumeration:
 off
 error
 warn
 info
 debug
 debug2
 debug3
 debug4

Default:

--info (--debug for DEBUG builds)

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro
yangdiff-pro
yangdump-pro

Example:

netconfd-pro --log-level=debug \
 --log=~/server.log&

 

3.77  --log-mirroring

The --log-mirroring parameter is a synonym for --log-console.

 

3.78  --log-stderr

The --log-stderr parameter directs that error level log output be directed to STDERR rather than STDOUT. (Note however that if --log is present, all error level messages will be directed to the specified log file … --log-stderr has no effect in this case.)

 

--log-stderr parameter

 

Syntax

empty

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro

Example:

netconfd-pro --log-stderr > logFile&

! All log messages redirected to logFile except ...

! Error level messages displayed on console

 

 

3.79  --log-suppress-ctrl

The --log-suppress-ctrl parameter causes certain control parameters to br stripped from log messages.

 

--log-suppress-ctrl parameter

 

Syntax

empty

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro

Example:

netconfd-pro --log-suppress-ctrl

 

3.80 --log-syslog

The --log-syslog parameter directs log output to be sent to the local syslog daemon, rather than to STDOUT.  See the --log-console parameter for information on how log output may also be duplicated via STDOUT.

 

--log-syslog parameter

 

Syntax

empty

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro

Example:

netconfd-pro --log-syslog

 

3.81  --log-syslog-level

The --log-syslog-level parameter acts as a filter for the message level sent to the syslog or vendor output stream. The filter level is set by default to “info” if not specified.

The log levels are incremental, meaning that each higher level includes everything from the previous level, plus additional messages.

There are 7 settings that can be used:

 

--log-syslog-level parameter

 

Syntax

enumeration:
 off
 error
 warn
 info
 debug
 debug2
 debug3
 debug4

Default:

--info (--debug for DEBUG builds)

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro

Example:

Netconfd-pro --log=logfile \

> --log-level=debug \

> --log-syslog \

> --log-syslog-level=info &

 

3.82  --match-names

The --match-names parameter specifies how names are matched when performing UrlPath searches.

The following values are supported::

          The name must exactly match the node name for all characters in both name strings.

          The name must match the node name for all characters in both name strings.

          Strings are not case-sensitive.

          The name must exactly match the first N characters of just one node name,
which must be the only partial name match found.

          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.

          The name must exactly match the first N characters of any node name. The first one

          found will be used.

          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.

 

--match-names parameter

 

Syntax

enum:
exact
exact-nocase
one
one-nocase
first

 first-nocase

Default:

one-nocase

Min Allowed:

0

Max Allowed:

1

Supported by:

  yangcli-pro

Example:

yangcli-pro --match-names=exact

 

3.83  --message-indent

The --message-indent parameter specifies the number of spaces that will be used to add to the indentation level, each time a child node is printed during protocol messages such as NETCONF requests.  This does not affect the indentation for logging messages, which is controlled by the --indent parameter.

The value -1 requests that no newlines or indentation will be used in protocol messages..

 

--message-indent parameter

 

Syntax

int32 (-1 .. 9)

Default:

-1

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro

Example:

yangcli-pro --message-indent=2

 

3.84  --modpath

The --modpath parameter specifies the YANG module search path to use while searching for YANG files.  It consists of a colon (':') separated list of path specifications, commonly found in Unix, such as the $PATH environment variable.

This parameter overrides the $YUMAPRO_MODPATH environment variable, if it is present.

--modpath parameter

 

Syntax

string: list of directory specifications

Default:

$YUMAPRO_MODPATH environment variable

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro
yangdiff-pro
yangdump-pro

Example:

yangcli-pro \
 --modpath=”~/testmodules:~/modules:~/trunk/netconf/modules”

 

3.85  --module

The --module parameter is a leaf-list of modules that should be loaded automatically when the program starts.

The program will attempt to load each module in the order the parameters were entered.

For the netconfd-pro program, If any modules have fatal errors then the program will terminate.

For the yangdump-pro program, each module will be processed as requested.

 

--module parameter

 

Syntax

module name or filespec

Default:

none

Min Allowed:

0

Max Allowed:

unlimited

Supported by:

netconfd-pro
yangcli-pro
yangdump-pro

Example:

yangcli-pro \
 --module=test1 \
 --module=test2

 

3.86  --ncport

The --ncport parameter specifies the TCP port number that should be used for NETCONF sessions.

This parameter specifies the TCP port number to use when a NETCONF session is created during the startup of the program.  The parameter can only be entered once.

 

--ncport parameter

 

Syntax

uint32

Default:

830

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --server=myserver
 --ncport=22 \
 --user=fred
 --password=mypassword

 

3.87  --no-aliases

The --no-aliases  disables the alias substitution feature. The alias file will not be read. The aliases and alias commands will be disabled. The default  is not present

--no-aliases parameter

 

Syntax

empty

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --no-aliases

 

3.88  --no-config

The --no-config parameter specifies that the default configuration file (/etc/yumapro/yangcli_pro.conf) should not be loaded, even if it is present.

 

--no-config parameter

 

Syntax

empty

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro
yangdiff-pro
yangdump-pro

Example:

yangcli-pro --no-config

 

3.89  --no-password

The --no-password parameter indicates that no user password is needed for the connection. It is used when connecting to a server in batch mode.

 

--no-password parameter

 

Syntax

empty

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --no-password \

   [server connect parms]

 

3.90  --optional

The --optional parameter specifies the the default for the $$optional global variable.

If 'true' then the user will be prompted to enter optional nodes for all input.

If 'false' then the user will not be prompted to enter optional nodes for all input.

This parameter affects all YANG input and should normally not be used. The fill-optional parameter should be used

instead.

 

--optional parameter

 

Syntax

boolean

Default:

FALSE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --optional=true

 

3.91  --password

The --password parameter specifies the password string that should be used when a NETCONF session is connected during the startup of the program.

 

--password parameter

 

Syntax

string

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --server=myserver \
 --password=yangrocks \
 --user=andy

3.92  --private-key

The --private-key parameter specifies 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.

 

--private-key parameter

 

Syntax

string

Default:

$HOME/.ssh/id_rsa

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \

    --private-key=~/.ssh/mykey

 

 

3.93  --prompt

The --prompt parameter is used to set the command line prompt to the user defined value.

This parameter is supported only for yp-shell.

 

The prompt can also be set using the $$prompt variable at any time.  If the --prompt CLI parameter is set

then that value will be used as the prompt when yp-shell starts. If prompt is used, prompt-name and prompt-type will be ignored.

--prompt parameter

 

Syntax

String (length "1 .. 512")

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --prompt=session1

 

3.94  --prompt-name

The --prompt-name parameter customize yumaworks as prompt name for yp-shell.

--prompt-name parameter

 

Syntax

String (length "1 .. 512")

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --prompt-name=yumaworks

 

3.95  --prompt-type

The --prompt-type parameter specifies the verbosity of the prompt storing.

The values allowed are 'brief', 'normal' and 'full'.

 

--prompt-type parameter

 

Syntax

enum:
 brief
 normal
 full

Default:

normal

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

Yangcli-pro --prompt-type=full

 

 

3.96  --protocols

The --protocols parameter specifies which protocol versions the program or session will attempt to use. Empty set is not allowed.

--protocols parameter

 

Syntax

bits

Default:

“netconf1.0 netconf1.1”

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro

Example:

yangcli-pro --protocols=netconf1.0

 

3.97  --public-key

The --public-key parameter specifies 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.

 

--public-key parameter

 

Syntax

string

Default:

$HOME/.ssh/id_rsa.pub

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --public-key=~/.ssh/mykey.pub

 

 

3.98  --restrict-edit-mode

The --restrict-edit-mode parameter controls whether an 'restrict edit mode' will be supported for yp-shell.  

If true then the yp-shell editing commands (create, merge, replace, delete, remove, insert, delete-all, remove-all, nvsave) will not be available to the user. Also, the NETCONF edit-config, copy-config, delete-config, commit, cancel-commit, discard-changes commands will not be available to the user. If true then only the config mode will be available for editing configuration data on the server. This parameter can be used instead of specifying individual disable-command parameters for the editing commands.

-- restrict-edit-mode

 

Syntax

boolean (true or false)

Default:

FALSE

Min Allowed:

0

Max Allowed:

1

Supported by:

yp-shell

Example:

yp-shell --restric-edit-mode=true

 

 

3.99  --runpath

The --runpath parameter specifies the directory search path to use while searching for script files.  It consists of a colon (':') separated list of path specifications, commonly found in Unix, such as the $PATH environment variable.

This parameter overrides the $YUMAPRO_RUNPATH environment variable, if it is present.

 

--runpath parameter

 

Syntax

string: list of directory specifications

Default:

$YUMAPRO_RUNPATH environment variable

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro
yangdiff-pro
yangdump-pro

Example:

yangcli-pro \
 --runpath=”~/testscripts”

 

3.100  --run-command

The --run-command parameter specifies a command will be invoked upon startup.

In the yangcli-pro program, if the auto-connect parameters are provided, then a session will be established before running the command.

 

--run-command parameter

 

Syntax

string

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \
 --run-command="history
 load=~/test3-history"

 

3.101  --run-script

The --run-script parameter specifies a script will be invoked upon startup.

In the yangcli-pro program, if the auto-connect parameters are provided, then a session will be established before running the script.

 

--run-script parameter

 

Syntax

string (file specification)

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \
 --run-script="test3-start"

 

3.102  --save-session-vars

The --save-session-vars parameter specifies if session variables will be saved when the program exits. If use-session-vars is 'false' then this variable is ignored.

If 'true', then session variables will be saved when the program exits, but only if user variables are being saved.

If 'false', then session variables will not be saved when the program exits.

 

--save-session-vars parameter

 

Syntax

boolean

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --save-session-vars=false

 

 

3.103  --script-input

The --script-input parameter specifies whether scripts run in interactive mode should attempt to fill in missing command parameters from the CLI command line or not.

If TRUE, then the user will be prompted for input when needed.

If FALSE, then script commands will be attempted with whatever parameters are present in the script.

 

--script-input parameter

 

Syntax

boolean

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --script-input=false

 

 

3.104  --server

The --server parameter specifies the IP address or DNS name of the NETCONF server that should be connected to automatically, when the program starts.

 

--server parameter

 

Syntax

string:IP address or DNS name

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --server=myserver

 

3.105  --server-commands

The --server-commands parameter specifies whether RPC operations learned from server YANG modules will be added as a command available to the user. The module ietf-netconf is exempt from this parameter. Use the disable-command parameter to disable individual NETCONF operations.

 

--server-commands parameter

 

Syntax

boolean

Default:

true

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --server-commands=false

 

3.106  --ssl-certificate

The --ssl-ceriticate parameter contains the file path specification for the file containing the client-side SSL certificate.

If both 'certificate' and 'key' files are present, the client will attempt to setup a secure connection with the server using the certificate and SSL key.

If this fails, and the 'ssl-fallback-ok' leaf is set to true, the client will attempt to setup a raw TCP connection with the server.

 

--ssl-certificate parameter

 

Syntax

filespec

Default:

$HOME/.ssl/yangapi-client.crt

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \
--ssl-certificate=~/certs/client.crt

 

 

3.107  --ssl-fallback-ok

The --ssl-fallback-ok parameter controls SSL connection behavior.  If true then an attempt to establish a plain TCP connection will be made if an SSL connection cannot be made. This parameter only applies of the 'transport' is 'ssl'.

 

--ssl-fallback-ok parameter

 

Syntax

boolean

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --ssl-fallback-ok=false

 

 

3.108  --ssl-key

The --ssl-key parameter contains the file path specification for the file containing the client-side SSL key certificate.

If both 'certificate' and 'key' files are present, the client will attempt to setup a secure connection with the server using the certificate and SSL key.

If this fails, and the 'ssl-fallback-ok' leaf is set to true, the client will attempt to setup a raw TCP connection with the server.

 

--ssl-key parameter

 

Syntax

filespec

Default:

$HOME/.ssl/yangapi-client.key

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \
--ssl-key=~/certs/client.key

 

3.109  --ssl-trust-store

The --ssl-strust-store parameter contains the file path specification for the file containing the client-side ssl trust-store,     or the path specification for the directory to use for finding trusted certificates. If the default value is used and the file is not found, then the default directory location '/etc/ssl/certs' will be used.

 

--ssl-trust-store parameter

 

Syntax

filespec

Default:

$HOME/.ssl/trust-store.pem

/etc/ssl/certs directory

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --ssl-trust-store=\   $HOME/certs/trust-store.pem

 

3.110  --subdirs

The --subdirs parameter controls whether sub-directories should be searched or not, if they are found during a module search.

If false, the file search paths for modules, scripts, and data files will not include sub-directories if they exist in the specified path.

 

--subdirs parameter

 

Syntax

boolean

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro  --subdirs=false

 

3.111  --term-length

The --term-length parameter specifies the length of the terminal to use for page mode output with the -More- prompt. This parameter is ignored in batch mode. It is only used if the output session is operating in interactive mode.

If the value 0 is used then the 'More' prompt will be disabled. Otherwise this value represents the number of lines to output for each screen in pagination output mode.

 

--term-length parameter

 

Syntax

uint16 (0..511)

Default:

FALSE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro  --term-length=24

 

3.112  --test-suite-file

The --test-suite-file parameter contains the file specification of the default test suite configuration file to use.

 

--test-suite-file parameter

 

Syntax

string:filespec

Default:

$HOME/.yumapro/.yangcli_pro_tests.conf

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \
  --test-suite-file=~/mytests.conf

 

3.113  --time-rpcs

The --time-rpcs parameter is used to 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.";

 

--time-rpcs parameter

 

Syntax

boolean

Default:

FALSE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --time-rpcs=true

 

3.114  --time-rpcs-stats

The --time-rpcs-stats parameter is used to control whether the timed rpc statistics should be saved if the time-rpcs parameter is set to 'true'.  If 'true', then timing statistics will be saved.

--time-rpcs-stats parameter

 

Syntax

boolean

Default:

FALSE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --time-rpcs-stats=true

 

3.115  --time-rpc-stats-file

The --time-rpc-stats-file parameter contains the file specification of the default rpc timing data file to use.

 

--time-rpcs-stats-file parameter

 

Syntax

string:filespec

Default:

$HOME/yangcli_pro_rpc_stats.txt

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \
 --time-rpc-stats-file=~/mystats.txt

 

3.116  --timeout

The --timeout parameter specifies the number of seconds that should pass before giving up on a response during a NETCONF session.  The value zero means wait forever (no timeout).

 

--timeout parameter

 

Syntax

uint32 (0 for no timeout; otherwise number of seconds to wait)

Default:

30 seconds

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --timeout=0

 

 

3.117  --transport

The --transport parameter specifies the NETCONF transport protocol to use.

This parameter is also supported in the 'connect' command.

There are 3 values supported:

  1. ssh: standard NETCONF SSH transport (RFC 4742 or RFC 6242)

  2. tcp: tail-f NETCONF over TCP transport

    Note that netconfd-pro does not support this transport protocol!

  3. tcp-ncx: YumaWorks NETCONF over TCP transport

    Note that netconfd-pro does support this transport protocol, if the netconfd-pro --socket-type CLI parameter is set to 'tcp'.

 

--transport parameter

 

Syntax

Enum (ssh,  tcp, or tpc-ncx)

Default:

ssh

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --transport=tcp-ncx

 

3.118  --use-data-templates

The --use-data-templates parameter specifies if variable expressions are enabled for data in XML, JSON or .conf instance documents.

If 'true', then text matching the pattern for variable expressions in these instance documents will be processed as variable expressions.

If 'false', then text matching the pattern for variable expressions in these instance documents will be treated as plain strings.

 

--use-data-templates parameter

 

Syntax

boolean

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \
  --use-data-templates=false

 

3.119  --use-rawxml

The --use-rawxml parameter specifies how file result variables will be read for XML files.  Controls whether the XML will be parsed against the target YANG object (the default) or injected into a variable or request message from the raw XML text in the file.

 

--use-rawxml parameter

 

Syntax

boolean

Default:

FALSE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --use-rawxml=true

 

3.120  --use-session-vars

The --use-session-vars parameter specifies how global variables will be handled when set from the context of a named session.

If 'true', then an assignment (e.g., $$foo = 'bar') will only affect the session-specific instance of the variable, and only be visible within the scope of the named session.

If 'false', then assignment statements for global variables will affect the global instance of the variable, and be visible to all sessions.

If the current session is the default session, and not a named session, then the value of this variable is ignored, and all global variable assignments will affect the global instance of the variable, and be visible to all sessions.

 

--use-session-vars parameter

 

Syntax

boolean

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --use-session-vars=false

 

3.121  --use-traceid

The --use-traceid parameter controls whether the 'trace-id' attribute will be set in the RPC calls or not. By default, 'trace-id' attribute is disabled. If 'true', then the XML RPC will contain 'trace-id' attribute.

 

--use-traceid parameter

 

Syntax

boolean

Default:

FALSE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --use-traceid=true

 

3.122  --use-xmlheader

The --use-xmlheader parameter specifies how file result variables will be written for XML files.

Controls whether the XML preamble header will be written or not.

--use-xmlheader parameter

 

Syntax

boolean

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --use-xmlheader=false

 

3.123  --user

The --user parameter specifies the user name string on the NETCONF server that should be used when establishing a NETCONF session.

--user parameter

 

Syntax

string:user name

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --user=admin \
 --server=myserver

3.124  --uservars-file

The --uservars-file parameter contains the file specification of the user global variables XML file to use.

--uservars-file parameter

 

Syntax

string:filespec

Default:

$HOME/.yumapro/yangcli_pro_uservars.xml

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro \
 --uservars-file=~/myvars.xml

 

3.125  --version

The --version parameter causes the program version string to be printed, and then the program will exit instead of running as normal.

All YumaPro version strings use the same format:

DEBUG: <major>.<minor>.<svn-build-version>

or

NON-DEBUG: <major>.<minor>-<release>

An example version number that may be printed:

 

 

yangcli-pro 20.10-1

 

 

This parameter can be combined with the --help parameter.

--version parameter

 

Syntax

empty

Default:

none

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro
yangdiff-pro
yangdump-pro

Example:

yangcli-pro --version

 

3.126  --warn-error

The --warn-error parameter controls whether all warnings are elevated to errors.

If ‘true’ then warnings that are enabled will be elevated to errors for reporting purposes.

If the --warn-off parameter is entered for a specific error, that warning is considered disabled, and will not be elevated to an error.

 

--warn-error parameter

 

Syntax

boolean

Default:

false

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro
yangdiff-pro
yangdump-pro

Example:

yangcli-pro --warn-error=true

 

 

3.127  --warn-idlen

The --warn-idlen parameter controls whether identifier length warnings will be generated.

The value zero disables all identifier length checking.  If non-zero, then a warning will be generated if an identifier is defined which has a length is greater than this amount.

--warn-idlen parameter

 

Syntax

uint32: 0 to disable, or 8 .. 1023

Default:

64

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro
yangdiff-pro
yangdump-pro

Example:

yangcli-pro --warn-idlen=50

 

3.128  --warn-linelen

The --warn-linelen parameter controls whether line length warnings will be generated.

The value zero disables all line length checking.  If non-zero, then a warning will be generated if a YANG file line is entered which has a length is greater than this amount.

Tab characters are counted as 8 spaces.

 

--warn-linelen parameter

 

Syntax

uint32: 0 to disable, or 40 .. 4095

Default:

72

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro
yangdiff-pro
yangdump-pro

Example:

yangcli-pro --warn-linelen=79

 

 

3.129  --warn-off

The --warn-off parameter suppresses a specific warning number.

The error and warning numbers, and the default messages, can be viewed with the yangdump-pro program by using the --show-errors configuration parameter.

The specific warning message will be disabled for all modules.  No message will be printed and the warning will not count towards the total for that module.

 

--warn-off parameter

 

Syntax

uint32: 1000 .. 1999

Default:

none

Min Allowed:

0

Max Allowed:

unlimited

Supported by:

netconfd-pro
yangcli-pro
yangdiff-pro
yangdump-pro

Example:

yangcli-pro --warn-off=1022

 

3.130  --warn-up

The --warn-up parameter elevates a specific warning number to an error.

The error and warning numbers, and the default messages, can be viewed with the yangdump-pro program by using the --show-errors configuration parameter.

The specific warning message will be elevated for all modules.  An error message will be printed and the warning will be counted towards the error total for that module.

 

--warn-up parameter

 

Syntax

uint32: 1000 .. 1999

Default:

none

Min Allowed:

0

Max Allowed:

unlimited

Supported by:

netconfd-pro
yangcli-pro
yangdiff-pro
yangdump-pro

Example:

yangcli-pro --warn-up=1022

 

3.131  --wildcard-keys

The --wildcard-keys parameter is used to enable wildcards on key leaf values.

Set to 'true' if UrlPath targets for GET operations are allowed to replace key values with the dash '-' character to indicate that all instances of that key are requested.

Set to false to treat the '-' character as a plain character if entered as a key value in a UrlPath string.

 

--wildcard-keys parameter

 

Syntax

boolean

Default:

FALSE

Min Allowed:

0

Max Allowed:

1

Supported by:

yangcli-pro

Example:

yangcli-pro --wildcard-keys=true

 

3.132  --with-enable-mode

The --with-enable-mode parameter controls whether an 'enable mode' will be supported for yp-shell.  

If set to 'true', the user must enter the 'enable' command to enter enable mode. If the 'enable password' has been configured then this password must be provided by the user in order to enter enable mode. Within enable mode, the 'config term' command can be used to enter configuration mode. If set to  'false', then enable mode will not be used and the 'enable', 'enable password', and “enable no-password” will not be present.

 

--with-enable-mode

 

Syntax

boolean (true or false)

Default:

FALSE

Min Allowed:

0

Max Allowed:

1

Supported by:

yp-shell

Example:

yp-shell --with-enable-mode=true

 

 

3.133  --with-notif-commands

The --with-notif-commands parameter controls whether notifications will be supported for yp-shell.  

If ‘true’ then yp-shell should include the create-subscription and cancel-subscription commands.

This parameter does not affect yp-shell echoing of notification messages. The --echo-notifs and --echo-notif-loglevel parameters need to be set appropriately to echo received notification messages.

 

--with-notif-commands

 

Syntax

boolean (true or false)

Default:

FALSE

Min Allowed:

0

Max Allowed:

1

Supported by:

yp-shell

Example:

yp-shell --with-notif-commands=true

 

3.134  --with-ocpattern

The --with-ocpattern parameter controls whether the server will support the OpenConfig usage of the YANG pattern statement.

 

--with-ocpattern parameter

 

Syntax

boolean

Default:

FALSE

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro

yangcli-pro

yangdump-pro

Example:

yangcli-pro --with-ocpattern=true

 

3.135  --with-term-msg

The --with-term-msg parameter controls whether the server will support Terminal Diagnostic messages.

If set to 'true', then the yumaworks-term-msg module will be loaded and enabled. Otherwise, this module will not be loaded. The <term-msg> notification is used by yp-shell for displaying terminal diagnostic messages.

The yp-shell and yangcli-pro programs will automatically display the <term-msg> as a terminal message if the --with-term-msg parameter is set to ‘true’.  If no <term-msg> events are sent by the server then this parameter has no effect.

For yp-shell, the --autonotif=true parameter setting must also be used, in order for this parameter to have any affect.

 

 

--with-term-msg parameter

 

Syntax

boolean

Default:

TRUE

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro

yangcli-pro

yp-shell

Example:

yangcli-pro --with-term-msg=false

 

 

3.136  --yangmap

The --yangmap parameter specifies a yangmap XML file that should be loaded into the program. See yumaworks-yangmap.yang for details on using YANG mappings in config term mode.

 

--yangmap parameter

 

Syntax

string

Default:

none

Min Allowed:

0

Max Allowed:

unlimited

Supported by:

yangcli-pro

Example:

yangcli-pro \

   --yangmap=~/HOME/maps/map1.xml

 

3.137  --yumapro-home

The --yumapro-home parameter specifies the project directory root to use when searching for files.

If present, this directory location will override the $YUMAPRO_HOME environment variable, if it is set. If this parameter is set to a zero-length string, then the $YUMAPRO_HOME environment variable will be ignored.

The following directories are searched when either the $YUMAPRO_HOME environment variable or this parameter is set:

 

yuma-home parameter

 

Syntax

string: directory specification

Default:

$YUMAPRO_HOME environment variable

Min Allowed:

0

Max Allowed:

1

Supported by:

netconfd-pro
yangcli-pro
yangdiff-pro
yangdump-pro

Example:

yangcli-pro \
 --yumapro-home=~/sw/netconf \
 --log=~/test.log&