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  netconfd-pro User Guide

2.1  Introduction

2.1.1  Features

2.1.2  Setting the Server Profile

2.1.3  Loading YANG Modules

2.1.4  Unloading YANG Modules

2.1.5  Starting netconfd-pro

2.1.6  Starting SIL-SA Subsystems with sil-sa-app

2.1.7  Stopping netconfd-pro

2.1.8  Signal Handling

2.1.9  Starting netconfd-pro with ypwatcher program

2.1.10  Signal Handling with ypwatcher program

2.1.11  Error Handling

2.1.12  Module Summary

2.1.13  Notification Summary

2.1.14  Operation Summary

2.1.15  Configuration Parameter List

2.1.16  Editing CLI Parameters at Run-Time

2.1.17  Using logrotate to Manage Log Files

2.1.18  Evaluation Version Restrictions

2.2  Capabilities

2.2.1  :base:1.0

2.2.2  :base:1.1

2.2.3  :candidate

2.2.4  :config-id

2.2.5  :confirmed-commit

2.2.6  :interleave

2.2.7  :netconf-monitoring

2.2.8  :notification

2.2.9  :partial-lock

2.2.10  :rollback-on-error

2.2.11  :schema-retrieval

2.2.12  :startup

2.2.13  :validate

2.2.14  :url

2.2.15  :with-defaults

2.2.16  :writable-running

2.2.17  :xpath

2.2.18  :yang-library

2.3  Databases

2.3.1  Database Locking

2.3.2  Using the <candidate> Database

2.3.3  Using the <running> Database

2.3.4  Using the <startup> Database

2.4  Sessions

2.4.1  User Names

2.4.2  Session ID

2.4.3  Server <hello> Message

2.4.4  Client <hello> Message

2.4.5  RPC Request Processing

2.4.6  Session Termination

2.5  Error Reporting

2.5.1  <error-severity> Element

2.5.2  <error-tag> Element

2.5.3  <error-app-tag> Element

2.5.4  <error-path> Element

2.5.5  <error-message> Element

2.5.6  <error-info> Element

2.5.7  Dynamic Error Messages

2.5.8  Using Annotations to Define Dynamic Error Messages

2.5.9  Replacing a Standard Error Message

2.5.10  Multi-Language Error Messages

2.5.11  instance-required Error Example

2.5.12  missing-choice Error Example

2.5.13  no-matches Error Example

2.5.14  not-in-range Error Example

2.6  Protocol Operations

2.6.1  <backup>

2.6.2  <cancel-commit>

2.6.3  <cancel-subscription>

2.6.4  <close-session>

2.6.5  <commit>

2.6.6  <copy-config>

2.6.7  <create-subscription>

2.6.8  <delete-backup>

2.6.9  <delete-config>

2.6.10  <discard-changes>

2.6.11  <edit-config>

2.6.12  <get>

2.6.13  <get-bulk>

2.6.14  <get-config>

2.6.15  <get-module-tags>

2.6.16  <get-my-session>

2.6.17  <get-schema>

2.6.18  <get-support-save>

2.6.19  <kill-session>

2.6.20  <load>

2.6.21  <load-bundle>

2.6.22  <lock>

2.6.23  <no-op>

2.6.24  <partial-lock>

2.6.25  <partial-unlock>

2.6.26  <restart>

2.6.27  <restore>

2.6.28  <set-log-level>

2.6.29  <set-my-session>

2.6.30  <shutdown>

2.6.31  <unload>

2.6.32  <unload-bundle>

2.6.33  <unlock>

2.6.34  <validate>

2.7  Access Control

2.7.1  NACM Module Structure

2.7.2  Users and Groups

2.7.3  Creating New Groups

2.7.4  Access Control Modes

2.7.5  Permissions

2.7.6  Special YANG Extensions For Access Control

2.7.7  Default Enforcement Behavior

2.7.8  Access Control Algorithm

2.7.9  Module Access Control Rules

2.7.10  RPC Access Control Rules

2.7.11  Data Access Control Rules

2.7.12  Passwords and crypt-hash

2.7.13  Using Module Tags with NACM

2.8  Using RESTCONF

2.8.1  Features

2.8.2  Resource Types

2.8.3  RESTCONF Headers

2.8.4   RESTCONF Query Parameters

2.9  Monitoring

2.9.1  Using Subtree Filters

2.9.2  Using XPath Filters

2.9.3  Using Time Filters

2.10  YANG-Library Monitoring

2.10.1  Using  YANG-Library

2.11  Notifications

2.11.1  Enabling Notifications

2.11.2  Subscriptions

2.11.3  Notification Log

2.11.4  Using Event Filters

2.11.5  Using Notification Filters

2.11.6  <notification> Element

2.11.7  Choosing System Notifications

2.11.8  <replayComplete> Event

2.11.9  <notificationComplete> Event

2.11.10  <sysStartup> Event

2.11.11  <netconf-session-start> Event

2.11.12  <netconf-session-end> Event

2.11.13  <netconf-config-change> Event

2.11.14  <netconf-capability-change> Event

2.11.15  <netconf-confirmed-commit> Event

2.11.16  <yang-library-change> Event

2.12  High Availability (YP-HA)

2.12.1  YP-HA Configuration

2.13  Configuration Templates

2.13.1  yumaworks-templates.yang

2.13.2  Configuration Template Example: NACM group

2.14  NETCONF Over TLS

2.14.1  TLS Configuration

2.15  IETF Call Home

2.15.1  Call Home Configuration

3  CLI Reference

3.1  --access-control

3.2  --allow-leaflist-delete-all

3.3  --allow-list-delete-all

3.4  --allowed-user

3.5  --alt-names

3.6  --annotation

3.7  --audit-log

3.8  --no-audit-log

3.9  --audit-log-append

3.10  --audit-log-candidate

3.11  --audit-log-console-level

3.12  --audit-log-level

3.13  --autodelete-pdu-error

3.14  --create-empty-npcontainers

3.15  --bundle

3.16  --callhome-retry-interval

3.17  --callhome-retry-max

3.18  --callhome-server

3.19  --callhome-sshd-command

3.20  --callhome-sshd-config

3.21  --callhome-subsys-command

3.22  --callhome-tls-server

3.23  --cert-default-user

3.24  --cert-usermap

3.25  --confdir

3.26  --config

3.27  --datapath

3.28  --default-style

3.29  --delete-empty-npcontainers

3.30  --deviation

3.31  --errmsg

3.32  --errmsg-lang

3.33  --eventlog-size

3.34  --factory-startup

3.35  --feature-disable

3.36  --feature-enable

3.37  --feature-enable-default

3.38  --fileloc-fhs

3.39  --ha-enabled

3.40  --ha-initial-active

3.41  --ha-server

3.42  --ha-server-key

3.43  --ha-sil-standby

3.44  --hello-timeout

3.45  --help

3.46  --help-mode

3.47  --home

3.48  --idle-timeout

3.49  --indent

3.50  --insecure-ok

3.51  --library-mode

3.52  --loadpath

3.53  --log

3.54  --log-append

3.55  --log-backtrace

3.56  --log-backtrace-detail

3.57  --log-backtrace-level

3.58  --log-backtrace-stream

3.59  --log-console

3.60  --log-event-drops

3.61  --log-header

3.62  --log-level

3.63  --log-mirroring

3.64  --log-pthread-level

3.65  --log-stderr

3.66  --log-syslog

3.67  --log-syslog-level

3.68  --log-vendor

3.69  --log-vendor-level

3.70  --match-names

3.71  --max-burst

3.72  --max-cli-sessions

3.73  --max-getbulk

3.74  --max-sessions

3.75  --modpath

3.76  --module

3.77  --module-tagmap

3.78  --netconf-capability

3.79  --netconf-tls-address

3.80  --netconf-tls-certificate

3.81  --netconf-tls-key

3.82  --netconf-tls-port

3.83  --netconf-tls-trust-store

3.84  --no-config

3.85  --no-startup

3.86  --no-nvstore

3.87  --no-watcher

3.88  --port

3.89  --protocols

3.90  --restconf-capability

3.91  --restconf-default-encoding

3.92  --restconf-server-url

3.93  --restconf-strict-headers

3.94  --running-error

3.95  --runpath

3.96  --save-owners

3.97  --session-sync-mutex

3.98  --sil-delete-children-first

3.99  --sil-invoke-for-defaults

3.100  --sil-missing-error

3.101  --sil-prio-reverse-for-deletes

3.102  --sil-skip-load

3.103  --sil-validate-candidate

3.104  --simple-json-names

3.105  --socket-address

3.106  --socket-port

3.107  --socket-type

3.108  --startup

3.109  start choice

3.110  --startup-error

3.111  --startup-factory-file

3.112  --startup-prune-ok

3.113  --subdirs

3.114  --subsys-timeout

3.115  --superuser

3.116  --system-notifications

3.117  --system-sorted

3.118  --target

3.119  --trim-whitespace

3.120  --usexmlorder

3.121  --version

3.122  --warn-error

3.123  --warn-idlen

3.124  --warn-linelen

3.125  --warn-off

3.126  --warn-up

3.127  --watcher-interval

3.128  --wildcard-keys

3.129  --with-callhome

3.130  --with-canonical

3.131  --with-config-id

3.132  --with-modtags

3.133  --with-netconf

3.134  --with-netconf-tls

3.135  --with-notifications

3.136  --with-restconf

3.137  --with-rollback-on-error

3.138  --with-ocpattern

3.139  --with-startup

3.140  --with-url

3.141  --with-url-ftp

3.142  --with-url-tftp

3.143  --with-validate

3.144  --with-warnings

3.145  --with-yang-api

3.146  --with-yang11-hello

3.147  --with-yp-coap

3.148  --with-yp-coap-dtls

3.149  --with-yp-shell

3.150  --with-yuma-system

3.151  --yangapi-server-url

3.152  --yumapro-home

3.153  --yp-coap-address

3.154  --yp-coap-dtls-port