netconfcentral logo

yumaworks-server

HTML

yumaworks-server@2018-04-21



  module yumaworks-server {

    yang-version 1;

    namespace
      "http://yumaworks.com/ns/yumaworks-server";

    prefix yser;

    import ietf-netconf-acm {
      prefix nacm;
    }
    import netconfd-pro {
      prefix ndpro;
    }
    import yumaworks-extensions {
      prefix ywx;
    }

    organization "YumaWorks, Inc.";

    contact
      "Support <support at yumaworks.com>";

    description
      "Runtime access to netconfd-pro server parameters.
        The following parameters can be changed at run-time
        and the new value will be activated immediately.

        * allowed-user
        * eventlog-size
        * hello-timeout
        * idle-timeout
        * log-level
        * max-burst
        * max-cli-sessions
        * max-getbulk
        * max-sessions
        * subsys-timeout

        The rest of the CLI parameters can be edited for
        activation at the next reboot.

        If the server has write permission to the
        configuration file (e.g., netconfd-pro.conf) then
        the parameters will be saved when the server exits.


     Copyright (c) 2017 - 2018, YumaWorks, Inc. All rights reserved.

     Redistribution and use in source and binary forms, with or
     without modification, is permitted pursuant to, and subject
     to the license terms contained in, the BSD 3-Clause License
     http://opensource.org/licenses/BSD-3-Clause";

    revision "2018-04-21" {
      description "Add no-nvstore to server";
    }

    revision "2017-12-30" {
      description "Initial version";
    }


    container server {
      nacm:default-deny-all;
      ywx:no-nvstore;
      description
        "Runtime access to netconfd-pro CLI parameters for
         immediate change or activate-on-restart";
      uses ndpro:netconfd-pro-parms;
    }  // container server
  }  // module yumaworks-server

Summary

  
  
Organization YumaWorks, Inc.
  
Module yumaworks-server
Version 2018-04-21
File yumaworks-server.yang
  
Prefix yser
Namespace http://yumaworks.com/ns/yumaworks-server
  
Cooked /cookedmodules/yumaworks-server/2018-04-21
YANG /src/yumaworks-server@2018-04-21.yang
XSD /xsd/yumaworks-server@2018-04-21.xsd
  
Abstract Runtime access to netconfd-pro server parameters. The following parameters can be changed at run-time and the new value will be ...
  
Contact
Support <support at yumaworks.com>

Description

 
Runtime access to netconfd-pro server parameters.
The following parameters can be changed at run-time
and the new value will be activated immediately.

* allowed-user
* eventlog-size
* hello-timeout
* idle-timeout
* log-level
* max-burst
* max-cli-sessions
* max-getbulk
* max-sessions
* subsys-timeout

The rest of the CLI parameters can be edited for
activation at the next reboot.

If the server has write permission to the
configuration file (e.g., netconfd-pro.conf) then
the parameters will be saved when the server exits.


Copyright (c) 2017 - 2018, YumaWorks, Inc. All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the BSD 3-Clause License
http://opensource.org/licenses/BSD-3-Clause

Objects

Type Key
Mandatory config
Optional config
Not config
Object Type Abstract
server container Runtime access to netconfd-pro CLI parameters for immediate change or activate-on-restart
   access-control leaf Controls how access control is initially enforced by the server.
   allow-leaflist-delete-all leaf If true, then the delete-all operation is enabled for deleting instances of leaf-list objects.
   allow-list-delete-all leaf If true, then the delete-all operation is enabled for deleting instances of list objects.
   allowed-user leaf-list Name of a user that is allowed to have access to the server via network management sessions. If any configured then the user name must be in this list, unless the user is the superuser account.
   alt-names leaf Match mode to use for UrlPath name searches.
   annotation leaf-list YANG deviation file representing model annotations. Processed the same as a deviation parameter except the module is not advertised to any client sessions. Only the deviation 'deviate add' operation can be used to transfer extension statements to another...
   audit-log-append leaf If present, the audit log will be appended not over-written. If not, the audit log will be over-written. Only meaningful if the 'audit-log' parameter is also present.
   audit-log-candidate leaf If true, then transactions to the candidate datastore will be recorded in the audit log. If false, then transactions to the candidate datastore will not be recorded in the audit log.
   audit-log-choice choice audit-log no-audit-log
      audit-log case audit-log
         audit-log leaf Filespec for the server audit log file to use in addition to the normal log file or STDOUT.
      no-audit-log case no-audit-log
         no-audit-log leaf Flag indicating that no audit log at all will be created. This is only relevant if --fileloc-fhs is 'true'.
   audit-log-console-level leaf Sets the minimum logging level needed to log datastore audit records to the server console log. This does not affect output to the audit log.
   audit-log-events leaf Configures the audit log events that will be saved as audit records to the audit log. This does not affect debug logging to the server console log.
   audit-log-level leaf Sets the minimum logging level needed to log datastore audit records to the audit log. This does not affect debug logging to the server console log.
   autodelete-pdu-error leaf If true, then configuration nodes provided in the edit payload (e.g., <config> element) that are conditional on 'when' statements must evaluate to true or else an operation-failed error will be returned. If false, then such 'false when' will be silently ...
   binary-display-maxlen leaf 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 bi...
   bundle leaf-list Specifies the name of a SIL bundle to load into system at boot-time.
   callhome-reconnect leaf If 'true' the server will attempt to start a new callhome connection if the client closes the session. If 'false' the server will not attempt to start a new callhome session after the client closes the session. Be careful that the server is running with ...
   callhome-retry-interval leaf Specifies the number of seconds to wait after a connect attempt to the callhome server has failed before attempting another connect attempt to that server.
   callhome-retry-max leaf Specifies the number of retry attempts the server should attempt to the callhome server before giving up. The value 0 indicates the server should never give up.
   callhome-server leaf-list Specifies a NETCONF over SSH callhome server that this server should attempt to initiate a callhome connection at boot-time. This string has the format: <server-id> '@' <server-ipv4-addr> [ ':' <port-num> ] server1@192.168.0.101 server1@192.16...
   callhome-sshd-command leaf Specifies the command string used to invoke the SSH server when a NETCONF over SSH callhome session is initiated.
   callhome-sshd-config leaf Specifies the SSH server configuration file to use when invoking the SSH server when a NETCONF over SSH callhome session is initiated. The default config file to use is a dynamic string using the pattern ch_sshd_config.<client>. It is located in the $HOME...
   callhome-subsys-command leaf Specifies the netconf subsystem to use in the default ch_sshd_config files to specify the NETCONF subsystem for the incoming NETCONF session expected on the NETCONF over SSH callhome session.
   callhome-tls-server leaf-list Specifies a NETCONF over TLS callhome server that this server should attempt to initiate a callhome connection at boot-time. This string has the format: <server-id> '@' <server-ipv4-addr> [ ':' <port-num> ] server1@192.168.0.101 server1@192.16...
   cert-default-user leaf The username to use if no username mapping is found for a NETCONF over TLS session. This parameter is non-standard and should only be used for debugging. This parameter is not available unless image is built with DEBUG=1 parameter.
   cert-usermap leaf-list Each entry specifies a certificate to user name mapping for NETCONF over TLS sessions. A mapping is a structured string using the form <user>@<fingerprint>. The 'user' field is the case-sensitive user name for the mapping. The 'fingerprint' field is a h...
   confdir leaf Specifies the CLI parameter configuration directory to use for extra configuration files. The server will check this directory for files that end with the suffix '.conf' and process them similar to the main configuration file. Other files will be ignored....
   config-choice choice config no-config
      config case config
         config leaf The name of the configuration file to use. Any parameter except this one can be set in the config file. The default config file will be not be checked if this parameter is present.
      no-config case no-config
         no-config leaf Do not the default .conf file even if it exists.
   convert-subtree-filter leaf If set to 'true' then subtree filters for retrieval operations might be converted to XPath expressions for processing. The subtree filtering algorithm has a minor flaw which can cause subtree containment nodes to be printed in the output even though a ne...
   create-empty-npcontainers leaf An empty non-presence container has no meaning in NETCONF/YANG so it may be created by the server. In particular, the presence of the container node with no child nodes is semantically equivalent to the absence of the container node. This is the default s...
   datapath leaf Internal file search path for config files. Overrides the YUMA_DATAPATH environment variable.
   db-lock-retry-interval leaf The number of milli-seconds to wait before attempting to get a DB-Config-Lock from the DB-API subsystem.
   db-lock-timeout leaf The total number of seconds to wait before giving up on a DB-Config-Lock from the DB-API subsystem. The value zero indicates that no retries will be attempted if the lock is busy.
   default-style leaf Selects the type of filtering behavior the server will advertise as the 'basic' behavior in the 'with-defaults' capability. The server will use this default handling behavior if the 'with-defaults' parameter is not explicitly set. Also, when saving a co...
   deviation leaf-list YANG deviation file. This parameter identifies a YANG module that should only be checked for deviation statements for external modules. These will be collected and applied to the real module(s) being processed. Deviations are applied as patches to the ...
   errmsg leaf-list Specifies a replacement string for a specific error number. Can specify error message for 1 specific language. The 'num' component must match the <error-number> found in status_enum.h. New error enums are always added at the end of the list, so the numbe...
   errmsg-lang leaf Specifies the language code for the error-message language. This is only relevant if there are errmsg parameters for multiple languages loaded in the program. This value should use the ISO-639-1 code.
   event-stream leaf-list Specifies the name of a NETCONF event stream that should be created by the server. Each event stream has its own subscriptions and notification replay buffer. Each event stream has the same replay buffer size, using the shared eventlog-size parameter. Ea...
   event-stream-map leaf-list Each entry specifies a module name to event-stream mapping for notification handling. A mapping is a structured string using the form <module-name>@<stream-name>. The 'module-name' field is the case-sensitive module name for the mapping. The 'stream-nam...
   eventlog-size leaf Specifies the maximum number of notification events that will be saved in each notification replay buffer. The oldest entries will be deleted first. The value 0 will cause the server to periodically clean out the messages that have already been delivered....
   feature-disable leaf-list Identifies a feature which should be considered disabled.
   feature-enable leaf-list Identifies a feature which should be considered enabled.
   feature-enable-default leaf If true, then features will be enabled by default. If false, then features will be disabled by default.
   fileloc-fhs leaf If true, then the server should use Filesystem Hierarchy Standard (FHS) directory locations to create and store server data. May need to run as root. The FHS server log file will be created by default unless the 'log' parameter is used, then that locatio...
   ha-enabled leaf Specifies whether the YP-HA protocol should be enabled, allowing High Availability Datastore Replication mode to be supported. If this parameter is enabled then the following parameters must be configured or the server will exit with an error: - ha-ser...
   ha-initial-active leaf Specifies the server name for the initial YP-HA active server. This is ignored unless ha-enabled=true. There is no default. This parameter is used to hardwire the initial High Availability roles instead of setting it in the yp-system init1 or init2 callb...
   ha-port leaf Specifies the default port to use for YP-HA protocol messages. Unless otherwise specified, this port number will be used by a standby server attempting to connect to the active server. (This parameter is not used yet).
   ha-server leaf-list Specifies a server in the YP-HA server pool. This string has the format: <server-id> '@' <server-addr> [ ':' <port-num> ] server1@192.168.0.101 server1@192.168.0.101:12040 The server running with this configuration must be listed in the ha...
   ha-server-key leaf Specifies the string the standby server must present to the active server during registration. Used to prevent servers from going the wrong HA pool. If not set then the active server will reject the YP-HA connection. This parameter must be set if the ha...
   ha-sil-standby leaf Specifies whether the edit callbacks such as SIL, SIL-SA and HOOK instrumentation will be invoked if the server is operating in HA standby mode
   hello-timeout leaf Specifies the number of seconds that a NETCONF session may exist before the client hello PDU is received. A session will be dropped if no hello PDU is received before this number of seconds elapses. If this parameter is set to zero, then the server will ...
   help leaf Print program help file and exit.
   help-mode choice brief normal full
      brief case brief
         brief leaf Show brief help text
      full case full
         full leaf Show full help text
      normal case normal
         normal leaf Show normal help text
   hide-module leaf-list Specifies the name of a module to hide from advertisements to client sessions. If the specified module name is loaded into the server, then this parameter will cause it to be omitted from the following data structures: - YANG 1.0 <hello> message - /n...
   home leaf Directory specification for the home directory to use instead of HOME.
   idle-timeout leaf Specifies the number of seconds that a session may remain idle without issuing any RPC requests. A session will be dropped if it is idle for an interval longer than this number of seconds. Sessions that have a notification subscription active are never d...
   import-version-bestmatch leaf Specifies if the bestmatch search feature should be used for import resolution when no revision-date field is specified in the import-stmt. If 'true' then the server will scan the module search path during startup and determine the most recent revisions ...
   indent leaf Number of spaces to indent (0..9) in formatted output.
   insecure-ok leaf 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.
   library-mode leaf If true, then the server will operate in YANG module library mode. It will find all the YANG modules and make them available for <get-schema> operations. The following NETCONF operations are available when the server is operating in library mode: ietf...
   loadpath leaf Directory load path for YANG or YIN modules. This will be checked before the modpath setting if present when finding modules. After all module and bundle parameters have been processed, this load path will be checked and the server will attempt to load an...
   log leaf Filespec for the log file to use instead of STDOUT. If this parameter is used on the command line then the --log-append parameter must also be present on the command line if append mode is desired.
   log-append leaf If present, the log will be appended not over-written. If not, the log will be over-written. Only meaningful if the 'log' parameter is also present.
   log-backtrace leaf If present, log output will include traceback detail for each log message, subject to further filtering by --log-backtrace-level and/or log-backtrace-stream qualifiers
   log-backtrace-detail leaf If present in conjunction with --log-backtrace log messages will include 'detailed' backtrace information (if supported by the compiler).
   log-backtrace-level leaf Indicates for which debug level(s) backtrace info will be generated. Param string is an XSD list: a double quoted series of whitespace separated (level) strings like "error warn debug"
   log-backtrace-stream leaf Indicates in which log stream(s) backtrace info will be included. Param string is an XSD list: a double quoted series of whitespace separated (log stream) strings like "logfile syslog"
   log-console leaf User friendly synonym for --log-mirroring.
   log-event-drops leaf Indicates if a log entry would be generated when a notification is dropped because the specific notification events are disabled with an event-filter configuration entry.
   log-header leaf Indicates what header elements to include in header output. Param string is an XSD list: a double quoted series of whitespace separated (element) strings like "custom localtime"
   log-level leaf Sets the debug logging level for the program.
   log-mirroring leaf If present in conjunction with --log, --log-syslog, and/or --log-vendor, log output will be directed to the normal stdout/stderr/logfile as well as to the syslog or vendor log stream
   log-pthread-level leaf Sets the pthread debug logging level filter for the program.
   log-stderr leaf If present, error level output be directed to stderr instead of stdout (as well as log file, if specified)
   log-syslog leaf If present, log output will be directed to the standard syslog interface. Yuma log priorities will be translated into the appropriate syslog equivalents.
   log-syslog-level leaf Sets the syslog debug logging level filter for output to the syslog file for the program.
   log-vendor leaf If present, log messages will be directed to a customer-written and registered callback function. This functionality is defined by an API specified in the YumaWorks API Reference Manual. In the absence of a registered callback, this parameter will direct ...
   log-vendor-level leaf Sets the vendor debug logging level filter for output to the vendor-specific log output file stream for the program.
   match-names leaf Match mode to use for UrlPath name searches.
   max-burst leaf Specifies the maximum number of notifications that should be sent to one session, within a one second time interval. The value 0 indicates that the server should not limit notification bursts at all.
   max-cli-sessions leaf Specifies the maximum number of concurrent CLI sessions that can be active at one time. The value 0 indicates that no artificial session limit should be used. The max-sessions parameter has precedence, so setting this parameter higher than 'max-sessions...
   max-getbulk leaf Specifies the maximum number of getbulk entries to request from a GET2 callback. This value will be used in the get2cb 'max_entries' field. The value 0 is used to indicate there is no max and the GET2 callback can return as many getbulk entries as desired...
   max-sessions leaf Specifies the maximum number of concurrent sessions that can be active at one time. The value 0 indicates that no artificial session limit should be used.
   max-strlen leaf The maximum number of bytes in length that will be accepted for a quoted string, by the internal token parser. This affects YANG and JSON input processing. Set this value to allow large binary leafs to be parsed by the server. This value includes 1 byte f...
   message-indent leaf The number of spaces to indent for each level of output in a protocol message, e.g. NETCONF request. The value zero means no indent, just line feeds. The value -1 means no indent and no line feeds either.
   modpath leaf Directory search path for YANG or YIN modules. Overrides the YUMA_MODPATH environment variable.
   module leaf-list YANG source module name to use.
   module-tagmap leaf-list Specifies a module tag mapping for use in module tags registry. The format is <modname>@<tag-string>. Examples: ietf-system@ietf:system-management openconfig-system@vendor:openconfig:system-management example-system@vendor:example.com:system-mana...
   netconf-capability leaf-list Specifies a URI value that should be added to the server NETCONF <hello> message as a NETCONF <capability> URI and monitoring data in the /netconf-state/capabilities container.
   netconf-tls-address leaf Specifies the IP address to listen on for NETCONF over TLS messages.
   netconf-tls-certificate leaf Contains the file path specification for the file containing the server SSL certificate, used for the NETCONF over TLS protocol.
   netconf-tls-key leaf Contains the file path specification for the file containing the server SSL key, used for the NETCONF over TLS protocol.
   netconf-tls-port leaf Specifies the TCP port to listen for NETCONF over TLS messages.
   netconf-tls-trust-store leaf Contains the file path specification for the file containing the server 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 director...
   no-log leaf Flag indicating that no main log file will be created. This is usually only relevant if --fileloc-fhs is 'true'. In this case the default log file will not be created. The --log-level parameter will be set to 'off'. This parameter will be ignored if the -...
   no-nvstore leaf Specifies that the server should not load or save using the normal APIs during transaction management. The 'start' choice will be ignored (e.g., --no-startup)) and the server will not attempt to load a startup-cfg.xml file. Transactions will not be saved...
   port leaf-list Specifies the TCP ports that the server will accept connections from. These ports must also be configured in the /etc/ssh/sshd_config file for the SSH master server to accept the connection and invoke the netconf subsystem. Up to 4 port numbers can be c...
   protocols leaf Specifies which protocol versions the program or session will attempt to use. Empty set is not allowed.
   restconf-capability leaf-list Specifies a URI value that should be added to the server as monitoring data in the /restconf-state/capabilities container.
   restconf-default-encoding leaf Specifies the default response encoding to use if the incoming request does not have an indication of preferred content type (e.g., no Content-Type header, no Accept header).
   restconf-server-url leaf The starting string for the server URL to use in Location header lines returned by RESTCONF.
   restconf-strict-headers leaf If set to 'true' the server will only accept requests with normative Accept and Content-Type headers entries specified in the RFC 8040 The Accept header must not be empty; otherwise 'not acceptable' error will be returned. Normative Accept header: appli...
   running-error leaf Controls the server behavior if any errors are encountered while validating the running database during the initial load of the running configuration at boot-time.
   runpath leaf Internal file search path for executable modules. Overrides the YUMA_RUNPATH environment variable.
   save-owners leaf Indicates if owner names should be saved for data in the running configuration, and startup configuration if supported.
   server-id leaf Server Identifier string to use for this server. Used in YControl and SIL-SA messages to identifier the server to all subsystems. Used in YP-HA to identify this server in the YP-HSA server pool
   session-sync-mutex leaf If present, force synchronous request processing (pthread version only). Ignored by the server
   sil-delete-children-first leaf If 'true', the server default behavior will be to treat all data deletion operations as if the ncx:sil-delete-children-first extension is present. A child node will be checked for a SIL callback before it is deleted. If 'false' the server default behavio...
   sil-invoke-for-defaults leaf If 'true' then when a SIL or SIL-SA callback will be invoked for default data nodes during the load and load_config operations. If 'false' then a SIL or SIL-SA callback will not be invoked for default data nodes.
   sil-missing-error leaf If 'true' then when a module is loaded, but the SIL library code for the module is not found, an error will be returned instead of a warning printed. If 'false' then when a module is loaded, but the SIL library code for the module is not found, no error ...
   sil-prio-reverse-for-deletes leaf Specifies whether edit transactions are validated by the regular SIL priority of should be reversed for DELETE edits. This parameter can be used to delete leafref nodes with referenced by node in reverse order. If 'false' then the SIL priority will not ...
   sil-root-check-first leaf If 'true', the server will perform a YANG validation check before the SIL validate callbacks are invoked for an edit-config operation. This is always done for a load-config or commit operation. If 'false', the server will invoke the SIL validate callback...
   sil-skip-load leaf If present, the server will not invoke the SIL callbacks during initial system initialization when the startup configuration file is loaded into the running datastore.
   sil-test-get-when leaf If 'true', the server will evaluate 'when' statements for GET2 callback requests for config=false nodes. If 'false' then the SIL or SIL-SA callback is expected to test the 'when' condition internally somehow and return a no-instance error if the condition...
   sil-validate-candidate leaf If true, the server will invoke the VALIDATE phase for SIL and SIL-SA callbacks when each edit is made to the candidate datastore. If false, the server will not invoke the VALIDATE phase for SIL and SIL-SA callbacks when each edit is made to the candidat...
   simple-json-names leaf If true, the server will NOT output name of the module in which the data node is defined. If false, a namespace-qualified member name will be used for all members of a top-level JSON object and then also whenever the namespaces of the data node and its p...
   snmp-agent-role leaf Specifies the SNMP agent role.
   snmp-subagent-priority leaf A value between 1 and 255, used to achieve a desired configuration when different sessions register identical or overlapping regions. Subagents with no particular knowledge of priority should register with the default value of 127. In the master agent's ...
   socket-address leaf Specifies the IP address to listen on when the socket-type parameter is set to 'tcp'. Ignored if the socket-type is 'aflocal'. Note that this parameter specifies the IP address for internal <ncx-connect> protocol messages. The server will accept NETCONF...
   socket-port leaf Specifies the TCP port number to listen on when the socket-type parameter is set to 'tcp'. Ignored if the socket-type is 'aflocal'. Note that this parameter specifies the port number for internal <ncx-connect> protocol messages. The server will accept N...
   socket-type leaf Specifies which type of socket the server should create for incoming <ncx-connect> protocol sessions. Note that this parameter specifies the socket type for internal <ncx-connect> protocol messages. The server will use TCP connections for NETCONF sessio...
   start choice select startup config for boot load
      factory-startup case factory-startup
         factory-startup leaf Force the system to use the factory configuration and delete the startup config file if it exists. Force the NV-storage startup to contain the factory default configuration.
      no-startup case no-startup
         no-startup leaf If present, do not load the startup config file. Use the factory default settings but do not overwrite the NV-storage startup unless it is altered. This option does not delete the startup config file if it exists.
      startup case startup
         startup leaf The full or relative filespec of the startup config file to use. If present, overrides the default startup config file name 'startup-cfg.xml', This will also override the YUMAPRO_DATAPATH environment variable and the datapath CLI parameter, if the first...
   startup-error leaf Controls the server behavior if any errors are encountered while loading the startup configuration file into the running configuration at boot-time. It is possible for the startup configuration to contain errors within optional nodes. If this parameter i...
   startup-factory-file leaf The full or relative filespec of the factory startup config file to use. If the --factory-startup parameter is used, or no startup file is specified or found, then the server will look for this filespec. If found, then it will copied to the startup config...
   startup-prune-ok leaf If set to 'true' then the server will prune unknown data nodes from the startup configuration instead of treating this as an error. A log_info message will be printed. If other known data nodes depend on the pruned nodes, then an error may occur anyway....
   startup-skip-validation leaf If set to 'true' then the server will skip all YANG validation of the startup configuration when it is loaded into the running configuration at boot-time. This should make the server boot faster but it assumes the startup configuration is already valid. ...
   subdirs leaf If false, the file search paths for modules, scripts, and data files will not include sub-directories if they exist in the specified path. If true, then these file search paths will include sub-directories, if present. Any directory name beginning with ...
   subsys-timeout leaf The number of seconds to wait for a response from a sub-system before declaring a timeout. The value '0' indicates that no timeout should be used.
   superuser leaf The user name to use as the superuser account. Any session associated with this user name will bypass all access control enforcement. See yuma-nacm.yang for more details. To disable the superuser account completely, set this parameter to the empty string...
   system-notifications leaf Indicates which YANG module(s) should be used for system notifications.
   system-sorted leaf Indicates whether ordered-by system leaf-lists and lists will be kept in sorted order. NOTE: This parameter is ignored. The server does not sort any list or leaf-list objects because YANG only requires that ordered-by user instances maintain the user-pr...
   target leaf The database to use as the target of edit-config operations.
   tls-crl-missing-ok leaf If true then a missing CRL Distribution Points within a client or CA certificate will be ignored. Not relevant unless tls-crl-mode is set to 'client' or 'ca'. If false, and CRL verification is enabled for the certificate, the TLS session will not be accep...
   tls-crl-mode leaf Specifies how Certificate Revocation List checking should be done for NETCONF over TLS sessions. This has no affect unless --with-netconf-tls=true is set.
   trim-whitespace leaf If true, then trim leading and trailing whitespace from XML string nodes. If false, adhere to the standard and do not trim any leading or trailing whitespace. The server previously would trim whitespace but no longer does this by default. This leaf must ...
   usexmlorder leaf If present, then XML element order will be enforced. Otherwise, XML element order errors will not be generated if possible. Default is no enforcement of strict XML order.
   version leaf Print program version string and exit.
   warn-error leaf Control whether all warnings are upgraded to errors. If 'true' then all warnings will be treated as errors unless a warn-off parameter is set to disable a specific warning.
   warn-idlen leaf Control 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-linelen leaf Control 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 the line length is greater than this amount. Tab characters are counted as 8 spaces.
   warn-off leaf-list Control whether the specified warning number will be generated and counted in the warning total for the module being parsed.
   warn-up leaf-list Control whether the specified warning number will be upgraded to an error and counted in the error total for the module being parsed.
   watcher-parm choice Automatic server state monitoring support. ypwatcher program periodically checks if the server is alive and if not restart the server and write the event into syslog.
      no-watcher case no-watcher
         no-watcher leaf Control the ypwatcher program. If present, do not launch ypwatcher program. If this parameter is present, then the --watcher-interval parameter cannot be present.
      watcher-interval case watcher-interval
         watcher-interval leaf Specifies the sleep interval between ypwatcher program attempts to check availability of the server. Provided value is in seconds. The server does not accept the value of 0 for this parameter. The minimal acceptable value is 1 second. The default value i...
   wildcard-keys leaf 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 ...
   with-callhome leaf This feature is only available if the server image is built with the flags WITH_CALLHOME=1. If set to 'true', then the IETF Callhome for SSH feature will be enabled. If set to 'false', then this feature will be disabled and the following CLI parameters w...
   with-canonical leaf If set to 'true', then the server will automatically convert XML and JSON input parameters to the canonical format for the YANG data type, if possible. The following built-in YANG data types are affected: - ipv6-address - ipv6-address-no-zone - dom...
   with-config-id leaf If set to 'true', then the YumaWorks :config-id capability will be enabled. This is used to help cache device configurations. It is an enterprise capability URI, not a standard YANG module URI. If set to 'false', then the YumaWorks :config-id capability...
   with-db-lock leaf If set to 'true', then the server will use the DB-API DB-Config-Lock service for all configuration edit transactions to the <running> datastore. All client edits will be require this lock be granted or it will fail. The server will use the db-lock-retry-...
   with-gnmi leaf If set to 'true', then the gNMI protocol will be enabled. Otherwise, the gNMI protocol will not be enabled. The incoming connection will be dropped if the protocol is disabled.
   with-maintenance-mode leaf If set to 'true', then allow the maintenance mode to be used. Otherwise, ignore all requests to place the server in maintenance mode.
   with-modtags leaf If set to 'true', then the module tags feature will be enabled. Otherwise, this feature will be disabled. If disabled, the module-tagmap parameter will be ignored and the ietf-module-tags module will not be loaded.
   with-netconf leaf If set to 'true', then the NETCONF over SSH protocol will be enabled. Otherwise, the NETCONF over SSH protocol will not be enabled. An incoming connection will be dropped if the protocol is disabled.
   with-netconf-tls leaf If set to 'true', then the NETCONF over TLS protocol will be enabled. Otherwise, the NETCONF over TLS protocol will not be enabled. An incoming connection will be dropped if the protocol is disabled. The default is set to false because the server will te...
   with-nmda leaf If set to 'true', then NMDA operations and YANG modules will be enabled: - ietf-datastores - ietf-origin - ietf-netconf-nmda
   with-notifications leaf If set to 'true', then the :notification:1.0 and :interleave:1.0 capabilities will be enabled. Otherwise, these capabilities will not be enabled.
   with-ocpattern leaf If true, then OpenConfig patterns with be checked. If the module name starts with the string 'openconfig-' then all pattern statements within that module are treated as POSIX patterns, not YANG patterns. If false, then the pattern statements in all modul...
   with-restconf leaf If set to 'true', then the RESTCONF protocol will be enabled. Otherwise, the RESTCONF protocol will not be enabled. The incoming connection will be dropped if the protocol is disabled.
   with-rollback-on-error leaf If set to 'true', then the NETCONF :rollback-on-error capability and feature will be enabled and advertised. Otherwise, this feature will not be enabled or advertised.
   with-snmp leaf If set to 'true', then the SNMP protocol will be enabled. Otherwise, the SNMP protocol will not be enabled. Incoming SNMP requests will be dropped if the protocol is disabled.
   with-startup leaf If set to 'true', then the :startup capability will be enabled. Otherwise, the :startup capability will not be enabled. This capability makes the NV-save operation an explicit operation instead of an automatic save.
   with-support-save leaf If set to 'true', then the yumaworks-support-save module will be loaded and enabled. Otherwise, this module will not be loaded. Ignored if the server image is not built with the WITH_SUPPORT_SAVE=1 compile flag. This module provides the <get-support-save>...
   with-term-msg leaf 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.
   with-url leaf If set to 'true', then the :url capability will be enabled and the 'file' scheme will be enabled. Otherwise, the :url capability will not be enabled. This capability requires a file system and may introduce security risks because internal files such as s...
   with-url-ftp leaf If set to 'true', then the 'ftp' protocol scheme will be enabled for the 'url' capability. Ignored if the 'with-url' parameter is false.
   with-url-tftp leaf If set to 'true', then the 'tftp' protocol scheme will be enabled for the 'url' capability. Ignored if the 'with-url' parameter is false.
   with-validate leaf If set to 'true', then the :validate capability will be enabled. Otherwise, the :validate capability will not be enabled. This capability requires extensive memory resources.
   with-warnings leaf If set to 'true', then the agt_record_warning function will be enabled, allowing the error-severity field to be incorrectly set to 'warning'. This violates the NETCONF standard and client software may reject the <error-severity> data as invalid if this i...
   with-yang-api leaf If set to 'true', then the YANG-API protocol will be enabled. Otherwise, the YANG-API protocol will not be enabled. The incoming connection will be dropped if the protocol is disabled.
   with-yang-patch-running leaf If set to 'true', the YANG-PATCH will be enabled when the server supports only the :writable-running capability. If 'false' then the YANG-PATCH requests will be rejected.
   with-yang11-hello leaf Control whether the NETCONF hello message should conform to the standard and leave out YANG 1.1 modules. If set to 'true', then leave out YANG 1.1 modules from <capability> used in <hello>. Also keep out of monitoring <capabilities> list. If 'false' then ...
   with-yp-coap leaf If set to 'true', then the YP-CoAP protocol will be enabled. Otherwise, the YP-CoAP protocol will not be enabled. This protocol is NOT SECURE. It SHOULD NOT be used unless privacy is provided by some other means.
   with-yp-coap-dtls leaf If set to 'true', then the YP-CoAP over DTLS protocol will be enabled. Otherwise, the YP-CoAP over DTLS protocol will not be enabled. This protocol is secure. It SHOULD be used instead of YP-CoAP without DTLS.
   with-yp-shell leaf If set to 'true', then the YP-SHELL protocol will be enabled. Otherwise, the YP-SHELL protocol will not be enabled. The incoming connection will be dropped if the protocol is disabled.
   with-yuma-system leaf If set to 'true', then the yuma-system module will be loaded and enabled. Otherwise, this module will not be loaded.
   with-yuma-time-filter leaf If set to 'true', then the yuma-time-filter module will be loaded and enabled. Otherwise, this module will not be loaded.
   with-yumaworks-config-change leaf If set to 'true', then the yumaworks-config-change module will be loaded and enabled. Otherwise, this module will not be loaded. This modules adds data to the 'netconf-config-change' notification. This data represents a security risk since it is not subj...
   with-yumaworks-event-filter leaf If set to 'true', then the yumaworks-event-filter module will be loaded and enabled. Otherwise, this module will not be loaded.
   with-yumaworks-getbulk leaf If set to 'true', then the yumaworks-getbulk module will be loaded and enabled. Otherwise, this module will not be loaded. If disabled the <get-bulk> operation will not be available.
   with-yumaworks-ids leaf If set to 'true', then the yumaworks-ids module will be loaded and enabled. Otherwise, this module will not be loaded. If not enabled then the extra transport types for netconfd-pro specific transports and control sessions will not be available.
   with-yumaworks-system leaf If set to 'true', then the yumaworks-system module will be loaded and enabled. Otherwise, this module will not be loaded. The <load>, <unload>, <load-bundle>, and <unload-bundle> operations will not be available. Other operations and data model augments w...
   with-yumaworks-templates leaf If set to 'true', then the yumaworks-templates module will be loaded and enabled. Otherwise, this module will not be loaded. Ignored unless the server is built with the WITH_TEMPLATES=1 compiler flag.
   yangapi-server-url leaf The starting string for the server URL to use in Location header lines returned by YANG-API.
   yp-coap-address leaf The IP address that the YP-CoAP protocol will use to listen for incoming requests. This will also be used as the source address in YP-CoAP packets sent by the server.
   yp-coap-dtls-port leaf The UDP port number that the YP-CoAP protocol will use to listen for incoming requests for CoAP over DTLS. This will also be used as the source port number in YP-CoAP packets sent by the server.
   yp-coap-port leaf The UDP port number that the YP-CoAP protocol will use to listen for incoming requests. This will also be used as the source port number in YP-CoAP packets sent by the server.
   yumapro-home leaf Directory for the yumapro project root to use. If present, this directory location will override the 'YUMAPRO_HOME' environment variable, if it is present. If a zero-length string is entered, then the YUMAPRO_HOME environment variable will be ignored.