This NED is equipped with a number of runtime configuration options "NED settings" allowing for
customization by the end user. All options are configurable using the NSO API for NED settings.
Most NED settings can be configured globally, per device profile or per device instance in the
following locations:
global
/ncs:devices/global-settings/ned-settings/zte-xpon/
profile
/ncs:devices/ncs:profiles/profile:/ned-settings/zte-xpon/
device
/ncs:/device/devices/device:/ned-settings/zte-xpon/
Profiles setting overrides global-settings and device settings override profile settings,
hence the narrowest scope of the setting is used by the device.
If user changes a ned-setting, then user must reconnect to the device, i.e.
disconnect and connect in order for the new setting to take effect.
From the NSO CLI the device instance NED settings for this NED are available under:
# config
# devices device dev-1 ned-settings zte-xpon
Press TAB to see all the NED settings.
- extended-parser <enum> (default auto)
Make the NED enable extensions to ease the task of the NSO CLI command parser. A common
problem with this parser is that it can easily get lost when trying to parse configuration not
supported by the YANG model. In particular it is very sensitive for unsupported config that
generates a mode switch.
auto - Uses turbo-mode when available, will use fastest availablemethod to load
data to NSO. If NSO doesn't support data-loading from CLI NED, robust-mode
is used.
robust-mode - The configuration dump is run through a pre-parser which is cleaning it from
all elements currently not supported in the YANG model (default).
turbo-mode - The NED executes the whole command parsing by itself, completely bypassing
the NSO CLI parser. The configuration dump is transferred to NSO using a
Maapi SetValues() call.
turbo-xml-mode - The NED executes the whole command parsing by itself, completely bypassing
the NSO CLI parser. The configuration dump is transferred to NSO in XML
format.
- use-write <true|false> (default true)
- set to True to send WRITE command at commit (Default)
- set to False to skip sending WRITE command
- wait-time <uint32> (default 0)
Some devices need more time to process some commands, before
accepting others.
E.g: interface gpon-olt_*/onu */type *
The ned-settings zte-xpon wait-time is the value in seconds to wait after the
above command was sent to the device.
2. ned-settings zte-xpon live-status
Configure NED settings related to live-status.
- time-to-live <int32> (default 50)
Define time-to-live for data fetched from the device via live-status.(default 50).
3. ned-settings zte-xpon connection
Configure settings specific to the connection between NED and device.
- number-of-retries <uint8> (default 0)
Configure max number of retries the NED will try to connect to the device before giving up.
Default 0.
- time-between-retry <uint8> (default 1)
Configure the time in seconds the NED will wait between each connect retry. Default 1s.
- terminal server-echo <true|false> (default false)
Enable (TELNET) server echo, i.e. use DO ECHO instead of DONT ECHO.
- terminal println-mode <enum> (default default)
default - System property line.separator default.
ocrnl - Translate carriage return to newline.
onocr - Translate newline to carriage return-newline.
onlret - Newline performs a carriage return.
- device-prompt <REGEXP> (default \A[\S ]+#[ ]?$)
When doing a READ, the ned will do a "show configuration" command and get everything until the prompt occurs.
To do that, we need a prompt regexp match. By default it is set to "\A[\S ]+#[ ]?$". In cases where the device actually
contains a configuration matching the prompt (e.g digit-map), there will be an early stop at reading the running config,
caused by the false match. This can be avoided by changing the regexp to properly match the device prompt
4. ned-settings zte-xpon proxy
Configure NED to access device via a proxy.
- remote-connection <enum>
Connection type between proxy and device.
ssh - SSH jump host proxy.
telnet - TELNET jump host proxy.
serial - Terminal server proxy.
- remote-address <union>
Address of host behind the proxy.
- remote-port <uint16>
Port of host behind the proxy.
- remote-command <string>
Connection command used to initiate proxy on device. Optional for ssh/telnet. Accepts
$(proxy/remote-xxx) for inserting remote-xxx config.
- remote-name <string>
User name on the device behind the proxy.
- remote-password <string>
Password on the device behind the proxy.
- authgroup <WORD>
Authentication credentials for the device behind the proxy.
- proxy-prompt <string>
Prompt pattern on the proxy host.
- remote-ssh-args <string>
Additional arguments used to establish proxy connection (appended to end of ssh cmd line).
5. ned-settings zte-xpon proxy-2
Configure NED to access device via a second proxy.
- remote-connection <enum>
Connection type between proxy and device.
ssh - SSH jump host proxy.
telnet - TELNET jump host proxy.
serial - Terminal server proxy.
- remote-address <union>
Address of host behind the proxy.
- remote-port <uint16>
Port of host behind the proxy.
- remote-command <string>
Connection command used to initiate proxy on device. Optional for ssh/telnet. Accepts
$(proxy/remote-xxx) for inserting remote-xxx config.
- remote-name <string>
User name on the device behind the proxy.
- remote-password <string>
Password on the device behind the proxy.
- authgroup <WORD>
Authentication credentials for the device behind the proxy.
- proxy-prompt <string>
Prompt pattern on the proxy host.
- remote-ssh-args <string>
Additional arguments used to establish proxy connection (appended to end of ssh cmd line).
6. ned-settings zte-xpon developer
Contains settings used by the NED developers.
- load-from-file <string>
Make the NED load a file containing raw device config when doing sync-from. Does only work on
NETSIM targets.
- model <uint32>
Simulate a model number.
- version <uint8>
Simulate a version number.
- device-type <enum> (default netsim)
Real or simulated device.
netsim - netsim.
device - device.
- progress-verbosity <enum> (default debug)
Maximum NED verbosity level reported by the NED. Default debug.
disabled - disabled.
normal - normal.
verbose - verbose.
very-verbose - very-verbose.
debug - debug.
- platform model <string>
Override device model name/number.
- platform name <string>
Override device name.
- platform version <string>
Override device version.
7. ned-settings zte-xpon console
Settings used while interacting with a device.
- ignore-errors <true|false> (default false)
Flag indicating if errors should be ignored.
- ignore-warnings <true|false> (default false)
Flag indicating if warnings should be ignored.
- ignore-retries <true|false> (default false)
Flag indicating if retries should be ignored.
- max-retries <uint8> (default 100)
Maximum number of retries of a command.
- retry-delay <uint16> (default 1000)
Number of ms before retrying a command.
- send-delay <uint32> (default 0)
Enable delay before sending commands.
- expect-timeout <uint32> (default 60000)
Set default timeout for sending commands.
- chunk-size <uint8> (default 1)
Enable executing commands in chunks.
- line-feed <string>
Overwrites default line-feed character.
- obfuscate-secret <true|false>
Secrets will be obfuscated in trace & log files.
- extension action <name> <init> <flush>
- name <string>
A name for the action.
- init <string>
Command sent to intialize action.
- flush <true|false>
Flush device buffer once action is completed.
7.4.1. ned-settings zte-xpon console extension action state
Extend state machine with answers/questions to handle.
- state <pattern> <method> <argument> <next>
- pattern <string>
Regular expression indicating action required.
- method <enum>
Method used to take action.
reportInfo - reportInfo.
reportError - reportError.
reportWarning - reportWarning.
sendCommand - sendCommand.
sendSecret - sendSecret.
sendRetry - sendRetry.
recoverError - recoverError.
- argument <string>
Additional info to method.
- next <string> (default DONE)
State once action is taken.
8. ned-settings zte-xpon logger
Settings for controlling logs generated.
- level <enum> (default info)
Set level of logging.
error - error.
info - info.
verbose - verbose.
debug - debug.
- java <true|false> (default false)
Toggle logs to be added to ncs-java-vm.log.
