> 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/f5-bigip/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/f5-bigip/ profile /ncs:devices/ncs:profiles/profile:/ned-settings/f5-bigip/ device /ncs\:/device/devices/device:/ned-settings/f5-bigip/ 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 f5-bigip Press TAB to see all the NED settings. ``` ## Table of contents *** ``` 1. ned-settings f5-bigip 2. trim-config-model 3. f5-bigip-cached-show-enable 4. rest-credentials 5. external-rest-credentials 6. developer-settings 6.1. exclude-load-config 6.2. exclude-check-sync-config 6.3. ignore-operation-config 6.4. input-filtering 6.4.1. values 6.5. exclude-partition-prefix 6.6. config-warning-ignore 6.7. sync-with-recursive 7. developer 8. imish 9. custom-commands 10. logger ``` ## 1. ned-settings f5-bigip *** ``` - device-group Set following to execute config sync after every commit (run /cm config-sync to-group ) - file-download-buffer-size When downloading a file through the live-status call admin@ncs% request devices device live-status bigip-actions file download local-path remote-file-path The default buffer size is 1 if the NED-setting file-download-buffer-size has not been set. This is the slowest download option but also the option where the md5sum will always match. - partition (default Common/) Specifies the active BIG-IP partition context. The NED issues a `cd /` command before fetching or applying configuration. In single-partition context default context is Common partition deployments (`Common/`). If custom partition context is desired, set this to the partition that the device instance should manage but make sure to narrow down the scope by setting `developer-settings sync-from-all-partitions` to false. In multi-partition deployments, leave it default or set to Common/, and enable `developer-settings sync-from-all-partitions` at least to pull config from all partitions. Note: the trailing slash is recommended (e.g. `automation/`, not `automation`). See also: `developer-settings sync-from-all-partitions`, `developer-settings multi-partition-check-sync`. - delay-before-send (default 0) A delay in milliseconds can be specified so that the NED will wait the specified amount of time before sending each command in the queue. ``` ## 2. ned-settings f5-bigip trim-config-model *** ``` - trim-config-model include-read-only-config (default true) Set to false if read-only leaves should be disabled from the config model. - trim-config-model include-default-config (default true) Set to false if default config should be disabled from the config model. Default config are config that changes upon device image reversion. ``` ## 3. ned-settings f5-bigip f5-bigip-cached-show-enable *** Enable cached-show. ``` - f5-bigip-cached-show-enable version (default true) This ned-setting is used to inject settings of some show commands into the config, when reading from device. The following show commands have some cached info: show sys version The injected 'config' can be usable in service code to check version. The values are injected under the /bigip:cached-show container. Example of injected config: cached-show version version 12.0.0 ``` ## 4. ned-settings f5-bigip rest-credentials *** Set REST credentials. ``` - rest-credentials port (default 443) - rest-credentials user (default admin) - rest-credentials password ``` ## 5. ned-settings f5-bigip external-rest-credentials *** Use below ned-setting to force the ned to use rest-credentials that is retrieved through a customized action. This ned-setting requires that action returns the credentials to the "auth" tag in "username:password" string format. If the external action fails, the ned will try to proceed with the usual rest-credentials possibly set by the user. external-rest-credentials/callback-node-path should be set to the relative action location. external-rest-credentials/action-name should be set to the action name which is located in above path. Example (ned-setting): admin\@ncs% set devices device ned-settings f5-bigip external-rest-credentials callback-node-path /sample-action action-name get-cred-test-action admin\@ncs% commit admin\@ncs% request devices device disconnect admin\@ncs% request devices device sync-from result true Example (external action YANG): container sample-action { tailf:action get-cred-test-action { tailf:info "Perform self-test of the service"; tailf:actionpoint sample-action-self-test; output { leaf auth { type string; } } } } Example of action return (java): return new ConfXMLParam\[] { new ConfXMLParamValue(nsPrefix, "auth", new ConfBuf("restUser:restPassword"))}; ``` - external-rest-credentials callback-node-path - external-rest-credentials action-name ``` ## 6. ned-settings f5-bigip developer-settings *** Contains settings used for debugging (intended for NED developers). ``` - developer-settings clean-operational-cdb-on-sync-from (default false) Set to true if the operational CDB should be cleaned on each sync-from. - developer-settings selective-sync-from (default false) Set to true if a check over what modules the device has is needed before fetching config. - developer-settings no-hostname-verification (default false) If hostname is not recognized by the server, this can turn off hostname verification. By using this ned-setting the device's certificate subjectAltName field is never checked - developer-settings use-bigip-transaction (default false) Configures the usage of bigip transactions. - developer-settings load-from-file Make the NED load a file containing raw device config when doing sync-from. - developer-settings load-from-path List path this config belongs to. - developer-settings sync-from-path-filename Specify the path and filename to sync-from. - developer-settings multi-partition-check-sync (default false) Set to true so that check-sync (getTransId) includes config from ALL partitions when computing the transaction hash. Without this flag, check-sync only hashes the single partition set by `partition`, so changes in other partitions go undetected. DEPENDENCY: this setting MUST be paired with `sync-from-all-partitions true`. If `multi-partition-check-sync` is true and `sync-from-all-partitions` is false, the check-sync hash will include all partitions while sync-from only fetched one. This creates a systematic, persistent out-of-sync on every sync-from + check-sync cycle — not just a sporadic issue. Valid combinations: sync-from-all-partitions false + multi-partition-check-sync false -> single-partition mode ``` (default) sync-from-all-partitions true + multi-partition-check-sync false -> multi-partition fetch , single-partition hash sync-from-all-partitions true + multi-partition-check-sync true -> full multi-partition mode (recommended) sync-from-all-partitions false + multi-partition-check-sync true -> UNSUPPORTED: causes p ersistent out-of-sync ``` When `multi-partition-check-sync true` is active, the device can occasionally return config changes that were not issued through the NED (e.g. BIG-IP background sync). To suppress these, use `developer-settings exclude-check-sync-config`. - developer-settings reuse-hardware-data (default false) By default hardware data will be fetched every time the NED connects. Specify true if existing hardware data is to be reused, reducing the number of device calls - developer-settings sync-from-all-partitions (default false) When enabled: - The NED discovers all partitions via `list auth partition` on the device. - Each partition is fetched in a separate pass (`cd /`). - Partition-scoped CDB keys are stamped with the partition prefix (e.g. pool `/Common/pool-1` and pool `/automation/pool-1` coexist in CDB). - Global objects (`sys/*`, `auth/*`, `cli/*`, `net interface`, `net trunk`, etc.) are fetched once from Common and not duplicated per partition. - Sync-from time increases proportionally to the number of partitions. DEPENDENCY: if `multi-partition-check-sync true` is also required (recommended for consistent check-sync behaviour), set BOTH settings to true. Setting `multi-partition-check-sync true` without this setting causes persistent out-of-sync — see `multi-partition-check-sync` for details. Specify true if the configs from all partition should be fetched. Please check README 7.12. Writing and reading to all partitions with one device instance before using this ned-setting - developer-settings sync-from-verbose-detailed (default false) Specify if sync-from verbose shall list detailed paths. - developer-settings exit-tmsh-command (default quit) Specify what command should be issued when exiting tmsh. Default is quit. - developer-settings enter-imish-command (default ) DEPRECATED ``` ### 6.1. ned-settings f5-bigip developer-settings exclude-load-config *** Exclude config to be loaded into the NED, for example ltm rule *sys*.\*. ``` - developer-settings exclude-load-config - config-component Specify the config component to be excluded, for example ltm rule. - config-name Specify the config name to be excluded, for example _sys_.*. ``` ### 6.2. ned-settings f5-bigip developer-settings exclude-check-sync-config *** Exclude config to be used during check-sync, for example sys snmp .\*. ``` - developer-settings exclude-check-sync-config - config-component Specify the config component to be excluded, for example sys snmp. - config-name Specify the config name to be excluded, for example .*. ``` ### 6.3. ned-settings f5-bigip developer-settings ignore-operation-config *** Specify operation and config component to be ignored by the NED, for example modify /sys crypto cert.\* ``` - developer-settings ignore-operation-config - operation-and-config-component Specify the operation and config component to be ignored by the NED, for example modify /sys crypto cert.* ``` ### 6.4. ned-settings f5-bigip developer-settings input-filtering *** Specify what input data shall be filtered. ``` - developer-settings input-filtering - path-to-leaf Path to the leaf which the input data shall be filtered e.g /net/self/vlan. ``` #### 6.4.1. ned-settings f5-bigip developer-settings input-filtering values *** In this example }VLAN123}bad-data is to be replaced with VLAN123. ``` - values - filtered-value Specify the correct value after filtering e.g VLAN123. - unfiltered-values Specify the unfiltered value which are to be filtered e.g }VLAN123}bad-data. ``` ### 6.5. ned-settings f5-bigip developer-settings exclude-partition-prefix *** Specify a regex for the paths that should not have the partition name added as a prefix. Example: '.*auth/partition.*. ``` - developer-settings exclude-partition-prefix - path-to-exclude A regex which matches the path to exclude. ``` ### 6.6. ned-settings f5-bigip developer-settings config-warning-ignore *** Device warning regexp entry list. ``` - developer-settings config-warning-ignore - warning Warning regular expression, e.g. .* does not exist.*. ``` ### 6.7. ned-settings f5-bigip developer-settings sync-with-recursive *** Specify config component to be fetched by the NED with keyword:recursive. ``` - developer-settings sync-with-recursive - component Component, example: ltm virtual. ``` ## 7. ned-settings f5-bigip developer *** Contains settings used for debugging (intended for NED developers). ``` - developer platform model Override device model name/number. - developer platform name Override device name. - developer platform version Override device version. - developer progress-verbosity (default debug) Maximum NED verbosity level which will get written in devel.log file. disabled - disabled. normal - normal. verbose - verbose. very-verbose - very-verbose. debug - debug. ``` ## 8. ned-settings f5-bigip imish *** ``` - imish use-imish (default false) - imish delay-before-imish (default 10000) Time in milliseconds to delay sending imish config. (See README sec. 7.18.) ``` ## 9. ned-settings f5-bigip custom-commands *** Specify custom commands the ned should use. ``` - custom-commands save-command (default save sys config) Specify what save command the ned should issue after commit. ``` ## 10. ned-settings f5-bigip logger *** ``` - logger level (default info) Set level of logging. error - error. info - info. verbose - verbose. debug - debug. - logger java (default false) Toggle logs to be added to ncs-java-vm.log. ``` -# adidional ned settings --- # 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/f5-bigip/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.