> For the complete documentation index, see [llms.txt](https://nso-docs.cisco.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://nso-docs.cisco.com/neds/cisco-provided-neds/furukawa-fx1/readme-ned-settings.md). # README-ned-settings ## NED settings details *** 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/furukawa-fx1/ profile /ncs:devices/ncs:profiles/profile:/ned-settings/furukawa-fx1/ device /ncs\:/device/devices/device:/ned-settings/furukawa-fx1/ 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 furukawa-fx1 Press TAB to see all the NED settings. ``` ## Table of contents *** ``` 1. ned-settings furukawa-fx1 2. live-status 3. connection 4. device 5. proxy 6. logger 7. developer ``` ## 1. ned-settings furukawa-fx1 *** ``` - extended-parser (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. disabled - disabled. 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. ``` ## 2. ned-settings furukawa-fx1 live-status *** ``` - live-status time-to-live (default 50) ``` ## 3. ned-settings furukawa-fx1 connection *** Configure settings specific to the connection between NED and device. ``` - connection ssh client Configure the SSH client to use. Relevant only when using the NED with NSO 5.6 or later. ganymed - The legacy SSH client. Used on all older versions of NSO. sshj - The new SSH client with support for the latest crypto features. This is the default when using the NED on NSO 5.6 or later. - connection ssh host-key known-hosts-file Path to openssh formatted 'known_hosts' file containing valid host keys. - connection ssh host-key public-key-file Path to openssh formatted public (.pub) host key file. - connection ssh auth-key private-key-file Path to openssh formatted private key file. - connection ssh keep-alive-interval (default 0) Configure SSH client keep alive interval in seconds, default 0 (i.e. no keep-alive). The keep-alive is implemented in the client by sending an ssh 'ignore' message on the given interval. - connection number-of-retries (default 0) Configure max number of retries the NED will try to connect to the device before giving up. Default 0. - connection time-between-retry (default 1) Configure the time in seconds the NED will wait between each connect retry. Default 1s. - connection connector Change the default connector, e.g. 'ned-connector-default.json'. - connection send-login-newline (default false) Send an initial newline in the login phase to wake device. - connection terminal width (default 100000) - connection terminal height (default 24) ``` ## 4. ned-settings furukawa-fx1 device *** ``` - device refresh-on-commit (default true) On 'commit', the NED will send a 'refresh' command to device. - device show-sync-full-config (default true) On getting config, the NED will retrieve full configuration from device [true] (faster) or just the modeled data [false]. - device suppress-commands (default false) Don't allow commands, such as deletion, for important nodes. - device trans-id-method (default last-edit-timestamp) Configure how the NED shall calculate the transaction id. Typically used after each commit and for check-sync operations. config-hash - Use a snapshot of the running config for calculation. last-edit-timestamp - Use the 'LAST EDIT' time stamp generated by the device for calculation. last-save-timestamp - Use the 'LAST SAVE' time stamp generated by the device for calculation. ``` ## 5. ned-settings furukawa-fx1 proxy *** Configure NED to access device via a proxy. ``` - proxy remote-connection Connection type between ned, proxy and device. ssh - Start a new ssh client on proxy and connect to device (i.e. will launch interactive shell on proxy). telnet - Start a new telnet client on proxy and connect to device (i.e. will launch interactive shell on proxy). serial - Connect through a terminal server to device. ssh-direct - Direct forward to device using ned local ssh client (i.e. without shell on proxy). telnet-direct - Direct forward to device using ned local telnet client (i.e. without shell on proxy). - proxy auth-key private-key-file Path to openssh formatted private key file for doing public key auth to device behind proxy. - proxy host-key-validation (default false) Set this to true to force host-key validation of device behind proxy. - proxy remote-address Address of host behind the proxy. - proxy remote-port Port of host behind the proxy. - proxy remote-name User name on the device behind the proxy. - proxy remote-password Password on the device behind the proxy. - proxy proxy-prompt Prompt pattern on the proxy host. - proxy remote-ssh-args Additional arguments used to establish proxy connection. - proxy remote-command Connection command used to initiate proxy on device. Optional for ssh/telnet. Accepts $address, $port, $name for inserting remote-xxx config - proxy remote-secondary-password Second password (e.g. enable) on the device behind the proxy. - proxy proxy-prompt2 Prompt pattern on the proxy after sending telnet/ssh command. - proxy menu regexp Menu regexp. - proxy menu answer Menu answer, i.e. selection/choice. ``` ## 6. ned-settings furukawa-fx1 logger *** Settings for controlling logs generated. ``` - logger level (default info) Set level of logging. error - error. info - info. verbose - verbose. debug - debug. - logger java (default true) Toggle logs to be added to ncs-java-vm.log. ``` ## 7. ned-settings furukawa-fx1 developer *** Contains settings used by the NED developers. ``` - developer load-from-file Make the NED load a file containing raw device config when doing sync-from.Does only work on NETSIM targets - developer version Simulate a version number. - developer device-type (default netsim) Real or simulated device. netsim - netsim. device - device. - developer platform model Override device model name/number. - developer platform name Override device name. - developer platform version Override device version. ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://nso-docs.cisco.com/neds/cisco-provided-neds/furukawa-fx1/readme-ned-settings.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.