The netconfd-pro server is designed to be modular so that various protocols and features can be enabled or disabled by the administrator.
Many features have both source code and CLI parameter controls of various code components.
The source code control must be enabled for the CLI parameter control to have any affect.
For example, the WITH_RESTCONF=1 build parameter has to be used when building the server image
in order for the --with-restconf CLI parameter to have any effect.
Refer to the YumaPro Developers Manual for details on building the server source code.
Note that the following types of parameters are described elsewhere:
- Parameters to load and configure YANG modules and bundles
- Parameters to configure a server to contact CallHome servers
- Parameters to configure a YP-HA Pool
- Logging Parameters
- YP-CoAP Protocol Parameters
- YANG Compiler Warning Control Parameters
The following table includes the CLI parameter, default value, and descriptions for netconfd-pro features:
CLI Parameter |
Default Value |
Description |
| enforcing | Configure the NETCONF Access Control (NACM) Enforcement Mode |
|
|
--allow-leaflist-delete-all |
false | Enable the 'delete-all' and 'remove-all' edit operations for YANG leaf-lists |
|
--allowed-user |
N/A | Specify user names allowed to establish management sessions |
|
--allow-list-delete-all |
false | Enable the 'delete-all' and 'remove-all' edit operations for YANG lists |
|
--config |
/etc/yumapro/netconfd-pro.conf | Specify the CLI configuration parameter file to use |
|
--create-empty-npcontainers |
true | Handle NP containers according to YANG 1.1 rules |
|
--default-style |
explicit | Specifies the type of default handling the server should use for YANG leafs and leaf-lists |
|
--eventlog-size |
1000 | Configure the NETCONF Notification Replay Buffer Size |
|
--factory-startup |
N/A | Load the factory default configuration at boot-time |
|
--ha-enabled |
false | Enable the YP-HA protocol |
|
--hello-timeout |
600 | Specify how long the server should wait to receiver a <hello> message from a client |
|
--home |
N/A | Override the $HOME environment variable |
|
--idle-timeout |
3600 | Specify how long a NETCONF session can be idle before it is dropped |
|
--library-mode |
false | Enable YANG Library Mode |
|
--max-burst |
10 | Specify the maximum number of notifications to send at once to a single session |
|
--max-sessions |
8 | Specify the maximum number of concurrent server sessions |
|
--max-getbulk |
10 | Specify the maximum number of YANG list entries to request in one GET2 callback |
|
--message-indent |
-1 | Specify the indentation level for protocol messages |
|
--netconf-capability |
N/A | Add a vendor--specific capability URI to NETCONF <hello> messages |
|
--no-config |
N/A | Do not use any configuration parameter files (e.g., /etc/yumapro/netconfd-pro.conf) |
|
--no-nvstore |
N/A | Disable built-in NV-storage (e.g, startup-cfg.xml) and use internal APIs instead |
|
--no-startup |
N/A | Do not load the NV-stored YANG configuration file, but save it if data is added |
|
--no-watcher |
N/A | Disable the ypwatcher program that restarts netconfd-pro if it crashes |
|
--port |
830 | Specify the TCP ports to listen for NETCONF sessions |
|
--protocols |
netconf1.0, netconf1.1 | Specify which NETCONF protocol versions to enable |
|
--restconf-capability |
N/A | Add a vendor-specific capability URI to the RESTCONF capability list |
|
--restconf-default-encoding |
json | Specify the default message encoding (XML or JSON) if the client does not specify a preference |
|
--restconf-server-url |
http://localhost | Specify the URL base string for RESTCONF Location headers |
|
--restconf-strict-headers |
false | Require correct Accept and ContentType headers according the RESTCONF standard |
|
--running-error |
stop | Specify how the server should handle an invalid <running> datastore at boot-time |
|
--save-owners |
false | Enable client owner ID tracking for configuration data |
|
--server-id |
server1 | Specify the server ID string (Required for YP-HA) |
|
--sil-missing-error |
false | Specify whether a module can be loaded without any SIL library found |
|
--sil-skip-load |
N/A | Specify whether SIL callbacks should be skipped at boot-time |
|
--sil-validate-candidate |
true | Disable SIL validate callbacks for <candidate> datastore, except for <commit> operation |
|
--socket-address |
0.0.0.0 | Specify the IPv4 or IPv6 address to listen for internal messages, if socket-type is 'tcp' |
|
--socket-port |
2023 | Specify the TCP port to listen for internal messages, if socket-type is 'tcp' |
|
--socket-type |
aflocal | Specify the socket type to listen for internal messages |
|
--startup |
startup-cfg.xml | Specify the XML file to NV-store YANG configuration data |
|
--startup-error |
stop | Specify how the server should handle an invalid NV-storage configuration, before server initialization |
|
--subsys-timeout |
30 | Specify how long to wait for subsystem responses |
|
--superuser |
N/A | Specify the user name that is exempt from NACM enforcement |
|
--target |
candidate | Specify whether the <candidate> or <running> datastore is allowed for the <edit-config> target |
|
--watcher-interval |
10 | Specify how often the ypwatcher program should check if netconfd-pro is alive |
|
--with-callhome |
false | Enable the NETCONF CallHome protocol |
|
--with-netconf |
true | Enable the NETCONF protocol |
|
--with-notifications |
true | Enable NETCONF Notifications |
|
--with-ocpattern |
false | Enable Posix Expression pattern processing for OpenConfig YANG modules |
|
--with-restconf |
true | Enable the RESTCONF protocol |
|
--with-snmp |
false | Enable the SNMP protocol |
|
--with-startup |
false | Enable the <startup> datastore |
|
--with-url |
true | Enable the <url> parameter in NETCONF <copy-config> operations |
|
--with-validate |
true | Enable the NETCONF <validate> operation |
|
--with-warnings |
false | Allow <error-severity> to be set to 'warning' |
|
--with-yang-api |
false | Enable the YANG-API protocol (Deprecated) |
|
--with-yang11-hello |
false | Specify whether strict YANG 1.1 <hello> message is sent |
|
--with-yp-shell |
true | Enable the yp-shell (CLI) protocol |