Table Of Contents

1  Preface

1.1  Legal Statements

1.2  Additional Resources

1.2.1  WEB Sites

1.2.2  Mailing Lists

1.3  Conventions Used in this Document

2  yangcli-pro User Guide

2.1  Introduction

2.1.1  Features

2.1.2  Starting yangcli-pro

2.1.3  Stopping yangcli-pro

2.1.4  Statements

2.1.5  Commands

2.1.6  Variables

2.1.7  Files

2.1.8  Scripts

2.1.9  Configuration Mode Editing

2.1.10  Configuration Parameter List

2.2  Invoking Commands

2.2.1  Command Prompt

2.2.2  Command Name

2.2.3  ncx:default-parm Extension

2.2.4  Parameter Mode Escape Commands

2.2.5  Using Inline XML or JSON Data

2.2.6  Using External XML

2.2.7  Using XPath Expressions

2.2.8  Special Parameter Handling

2.2.9  Command Completion

2.2.10  Command Line Editing

2.2.11  Command History

2.2.12  Command Responses

2.3  Controlling Terminal Output

2.3.1  Pipe Commands

2.3.2  Pagination

2.3.3   Display Mode

2.4  NETCONF Device Configuration

2.4.1  Creating Devices

2.4.2  Saving Devices

2.4.3  Multiple Devices

2.4.4  Saving the Configured Devices

2.4.5  Loading Additional Configured Devices

2.4.6  Displaying the Configured Devices

2.4.7  Displaying Devices

2.4.8  Saved Device Configuration File Format

2.4.9  Device Configuration File Example

2.5  NETCONF Schema Server Configuration

2.5.1  Creating New Schema Servers

2.5.2  Saving Schema Servers

2.5.3  Multiple Schema Servers

2.5.4  Displaying the Configured Schema Servers

2.5.5  Displaying A Schema Server

2.5.6   Saved Schema Server Configuration File Format

2.5.7  Schema Server Configuration File Example

2.6  NETCONF User Configuration

2.6.1  Creating New Users

2.6.2  Saving Users

2.6.3  Multiple Users

2.6.4  Saving the Configured Users

2.6.5  Loading Additional Configured Users

2.6.6  Displaying the Configured Users

2.6.7  Displaying Users

2.6.8  Saved User Configuration File Format

2.6.9  User Configuration File Example

2.7  NETCONF Session Configuration

2.7.1  Saving Sessions

2.7.2  Multiple Sessions

2.7.3  Changing the Active Session

2.7.4 Saving the Configured Sessions

2.7.5  Loading Additional Configured Sessions

2.7.6  Displaying the Configured Sessions

2.7.7  Displaying Sessions

2.7.8  Terminating a Named Session

2.7.9  Saved Session Configuration File Format

2.7.10  Session Configuration File Example

2.8  NETCONF Group Configuration

2.8.1  Create group

2.8.2  List group

2.8.3  Delete group

2.8.4  Add group

2.8.5  Remove Group

2.8.6  Show Group

2.8.7  Connect Group

2.8.8  Help Group

2.8.9  Saving Groups

2.8.10  Changing the Active group

2.9  Using NETCONF Sessions

2.9.1  Connection Startup Screen

2.9.2  Server Tailored Context

2.9.3  Retrieving Data

2.9.4  Modifying Data

2.9.5  Using Notifications

2.9.6  Configuration Parameters That Affect Sessions

2.9.7  Trouble-shooting NETCONF Session Problems

2.10  Automated Testing

2.10.1  Test Templates

2.10.2  YANG File Defining Test Templates

2.10.3   RPC Reply Testing

2.10.4  Using Wildcards in Data Response Testing

2.10.5  Example Test File

2.11  Call Home Server

2.11.1  Call Home Configuration

2.11.2  Call Home Accept Session Procedure

2.12  Privilege Mode In YP-Shell Enable Mode

2.12.1  enable

2.12.2  enable password

2.12.3  enable no-password

2.13   Privilege Mode In  YP-Shell Config Mode

2.13.1  Enable Privilege Mode

2.13.2  Disable Privilege Mode

2.14  Command Reference

2.14.1 action

2.14.2  alias

2.14.3  aliases

2.14.4  auto-test

2.14.5  cache

2.14.6  cd

2.14.7  clear

2.14.8  close-session

2.14.9  commit

2.14.10  config

2.14.11  config-commit

2.14.12 connect

2.14.13  copy-config

2.14.14  create

2.14.15  create-subscription

2.14.16  device-cfg

2.14.17  devices-cfg

2.14.18  delete

2.14.19  delete-config

2.14.20  discard-changes

2.14.21  edit-config

2.14.22  elif

2.14.23  else

2.14.24  enable

2.14.25  end

2.14.26  eval

2.14.27  eventlog

2.14.28  exit

2.14.29  fill

2.14.30  get

2.14.31  get-config

2.14.32  get-locks

2.14.33  get-my-session

2.14.34  get-schema

2.14.35  get-walk

2.14.36  group

2.14.37  help

2.14.38  history

2.14.39  if

2.14.40  insert

2.14.41  kill-session

2.14.42  list

2.14.43  load

2.14.44  lock

2.14.45  log-debug

2.14.46  log-error

2.14.47  log-info

2.14.48  log-warn

2.14.49  merge

2.14.50  mgrload

2.14.51  no-op

2.14.52  nvsave

2.14.53  pwd

2.14.54  quit

2.14.55  recall

2.14.56  record-test

2.14.57  release-locks

2.14.58  remove

2.14.59  replace

2.14.60  restart

2.14.61  run

2.14.62  save

2.14.63   schema-server-cfg

2.14.64  schema-servers-cfg

2.14.65  session

2.14.66  session-cfg

2.14.67  sessions-cfg

2.14.68  set-log-level

2.14.69  set-my-session

2.14.70  sget

2.14.71  sget-config

2.14.72  sget-data

2.14.73  show

2.14.74  shutdown

2.14.75  sleep

2.14.76  start-rpc-timing

2.14.77  start-session

2.14.78  start-timer

2.14.79  stop-rpc-timing

2.14.80  stop-session

2.14.81  stop-timer

2.14.82  terminal

2.14.83  test-suite

2.14.84  unlock

2.14.85  unset

2.14.86  user-cfg

2.14.87  users-cfg

2.14.88  uservars

2.14.89  validate

2.14.90  while

2.14.91  xget

2.14.92  xget-config

2.14.93  xget-data

3  CLI Reference

3.1  --aliases-file

3.2  --alt-names

3.3  --ask-password

3.4  --auto-discard-changes

3.5  --auto-keepalive

3.6  --auto-reconnect

3.7  --auto-reconnect-interval

3.8  --auto-reconnect-max

3.9  --autoaliases

3.10  --autocomp

3.11  --autoconfig

3.12  --autoconfig-conf-mode

3.13  --autodevices

3.14  --autohistory

3.15  --autoload

3.16  --autoload-cache

3.17  --autoload-get

3.18  --autoload-save-cache

3.19  --autonotif

3.20  --autonvsave

3.21  --autoschemaservers

3.22  --autosessions

3.23  --autotest

3.24  --autousers

3.25  --autouservars

3.26  --bad-data

3.27  --batch-mode

3.28  --binary-display-maxlen

3.29  --break-key-mode

3.30  --callhome-address

3.31  --callhome-enabled

3.32  --callhome-port

3.33  --callhome-tls-port

3.34  --callhome-user

3.35  --check-output

3.36  --check-output-error

3.37  --check-replies

3.38  --check-replies-error

3.39  --config

3.40  --config-autosave

3.41  --config-commit-mode

3.42  --config-edit-mode

3.43  --datapath

3.44  --default-module

3.45  --deviation

3.46  --disable-command

3.47  --display-mode

3.48  --echo-notif-loglevel

3.49  --echo-notifs

3.50  --echo-replies

3.51  --encoding

3.52  --entry-point

3.53  --feature-disable

3.54  --feature-enable

3.55  --feature-enable-default

3.56  --fill-optional

3.57  --fixorder

3.58  --force-target

3.59  --help

3.60  --help-mode

3.61  --help-width

3.62  --history-file

3.63  --home

3.64  --ignore-missing-vars

3.65  --indent

3.66  --insecure-ok

3.67  --keepalive-interval

3.68  --log

3.69  --log-append

3.70  --log-backtrace

3.71  --log-backtrace-detail

3.72  --log-backtrace-level

3.73  --log-backtrace-stream

3.74  --log-console

3.75  --log-header

3.76  --log-level

3.77  --log-mirroring

3.78  --log-stderr

3.79  --log-suppress-ctrl

3.80 --log-syslog

3.81  --log-syslog-level

3.82  --match-names

3.83  --message-indent

3.84  --modpath

3.85  --module

3.86  --ncport

3.87  --no-aliases

3.88  --no-config

3.89  --no-password

3.90  --optional

3.91  --password

3.92  --private-key

3.93  --prompt

3.94  --prompt-name

3.95  --prompt-type

3.96  --protocols

3.97  --public-key

3.98  --restrict-edit-mode

3.99  --runpath

3.100  --run-command

3.101  --run-script

3.102  --save-session-vars

3.103  --script-input

3.104  --server

3.105  --server-commands

3.106  --ssl-certificate

3.107  --ssl-fallback-ok

3.108  --ssl-key

3.109  --ssl-trust-store

3.110  --subdirs

3.111  --term-length

3.112  --test-suite-file

3.113  --time-rpcs

3.114  --time-rpcs-stats

3.115  --time-rpc-stats-file

3.116  --timeout

3.117  --transport

3.118  --use-data-templates

3.119  --use-rawxml

3.120  --use-session-vars

3.121  --use-traceid

3.122  --use-xmlheader

3.123  --user

3.124  --uservars-file

3.125  --version

3.126  --warn-error

3.127  --warn-idlen

3.128  --warn-linelen

3.129  --warn-off

3.130  --warn-up

3.131  --wildcard-keys

3.132  --with-enable-mode

3.133  --with-notif-commands

3.134  --with-ocpattern

3.135  --with-term-msg

3.136  --yangmap

3.137  --yumapro-home