> 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/tilgin-tgem/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/tilgin-tgem/ profile /ncs:devices/ncs:profiles/profile:/ned-settings/tilgin-tgem/ device /ncs\:/device/devices/device:/ned-settings/tilgin-tgem/

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 tilgin-tgem

Press TAB to see all the NED settings.

```

## Table of contents

***

```
1. ned-settings tilgin-tgem
2. logger
3. connection
4. api
   4.1. silent-error
   4.2. retriable-error
   4.3. info
   4.4. device
5. developer
```

## 1. ned-settings tilgin-tgem

***

```
- env <enum> (default prod)

  dev    - dev.

  test   - test.

  stage  - stage.

  prod   - prod.
```

## 2. ned-settings tilgin-tgem logger

***

Settings for controlling logs generated.

```
- logger level <enum> (default info)

  Set level of logging.

  error    - error.

  info     - info.

  verbose  - verbose.

  debug    - debug.


- logger java <true|false> (default true)

  Toggle logs to be added to ncs-java-vm.log.
```

## 3. ned-settings tilgin-tgem connection

***

Configure settings specific to the connection between NED and device.

```
- connection remote-protocol <enum>

  http   - http.

  https  - https.


- connection ssh client <enum>

  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 <string>

  Path to openssh formatted 'known_hosts' file containing valid host keys.


- connection ssh host-key public-key-file <string>

  Path to openssh formatted public (.pub) host key file.


- connection ssh auth-key private-key-file <string>

  Path to openssh formatted private key file.


- connection api-address <string>

  API address for device REST API.


- connection api-base-url <string> (default /nbi/soap)

  API base URL for device REST API.


- connection api-auth method <enum> (default header-credentials)

  header-credentials  - Use HTTP header credentials for authentication.


  Either of:

    - devices device ned-settings tilgin-tgem connection api-auth header-credentials credentials username <string>

    - devices device ned-settings tilgin-tgem connection api-auth header-credentials credentials password <password>

      Provide the password for authentication.

    - devices device ned-settings tilgin-tgem connection api-auth header-credentials headers username <string> (default Username)

    - devices device ned-settings tilgin-tgem connection api-auth header-credentials headers password <string> (default Password)

  OR:

    - devices device ned-settings tilgin-tgem connection api-auth oauth client-id <string>

      OAuth Client ID.

    - devices device ned-settings tilgin-tgem connection api-auth oauth client-secret <OAuth Client Secret>

      Provide the client secret for OAuth authentication.

    - devices device ned-settings tilgin-tgem connection api-auth oauth token-url <string>

      URL for obtaining OAuth tokens.


- connection ssl accept-any <true|false>

  Accept any SSL certificate presented by the device.
  Warning! This enables Man in the Middle attacks and
  should only be used for testing and troubleshooting.


- connection ssl certificate <binary>

  SSL certificate stored in DER format but since it is entered
  as Base64 it is very similar to PEM but without banners like
  "----- BEGIN CERTIFICATE -----".

  Default uses the default trusted certificates installed in
  Java JVM.

  An easy way to get the PEM of a server:
  openssl s_client -connect HOST:PORT


- connection logger silent <true|false> (default false)

  Toggle detailed logs to only written to store.
```

## 4. ned-settings tilgin-tgem api

***

Configure settings specific to the interaction between NED and device API.

```
- api web-service type <enum> (default soap)

  soap  - soap.


- api request page-size <uint32> (default 50000)

  Page size.


- api request error-handling throw-exception <true|false> (default true)

  Throw exception on API request errors.


- api request error-handling silent-mechanism enabled <true|false> (default false)


- api request retry-mechanism enabled <true|false> (default false)


- api request retry-mechanism retry-num <uint32> (default 3)

  Configurable number of retry attempts for failed requests (with specific errors).


- api request retry-mechanism backoff-secs <seconds> (default 2)

  Configurable time duration in seconds for the backoff period between retries.


- api sync config actions commit sortable-services default disabled <true|false> (default true)


- api sync devices actions send-signal payload type <enum> (default contact)

  contact  - contact.

  reboot   - reboot.

  reset    - reset.


- api sync devices actions send-signal payload timeout <uint32> (default 10000)


- api sync devices actions send-signal disabled <true|false> (default false)


- api sync devices meta key-info <enum> (default uid)

  Which device info to be used as key. Device info must be enabled.

  uid  - uid.

  mac  - mac.


- api sync devices filters filter-by <enum> (default query)

  Select which filters to be used for searching Devices.

  uid     - uid.

  oui     - oui.

  serial  - serial.

  mac     - mac.

  query   - query.


- api sync devices filters values uid <string>

  Set "uid" filter values.


- api sync devices filters values oui <string>

  Set "oui" filter values.


- api sync devices filters values serial <string>

  Set "serial" filter values.


- api sync devices filters values mac <string>

  Set "mac" filter values.


- api sync devices filters values query operator <enum> (default AND)

  Set the logical operator to be used
  between info based filters and generic queries.
  If AND is selected: the generic queries will be added to each info based filter iteration.
  If OR is selected: the generic queries will be queued to the info based filters list and
  will be used on a separate query iteration.

  AND  - AND.

  OR   - OR.


- api sync devices filters values query statements <string> (default uid:*)

  Set generic queries:
  * List of '[-]key:value' pairs; Use "-" before a key to negate the criterion.
  *              key is one of INFO_TYPE_* constants plus 'label', 'tag', 'tagset' and 'parameter' strings;
  *              value is freetext, can have "*",
  *              in case of 'parameter' key the value must be in form: 'param_path=param_value' (both param_path and param_value can have '*')
  *              Example: ['serial:V620*','-label:pending','parameter:*.DeviceInfo.ProvisionCode=12345']
  *              For INFO_TYPE - 'INFO_TYPE_LAST_CONTACT_TIME', search can be performed in follwing ways :-
  *                1. lastcontacttime:yyyy-mm-dd HH:MM; *  :- example ['lastcontacttime':2015-06-14 13:00;*] this will count from date 2015-06-14 13:00 till now.
  *                2. lastcontacttime:*; yyyy-mm-dd HH:MM  :- example ['lastcontacttime':*;2015-06-15 13:00] this will count all devices till 2015-06-15 13:00.
  *                3. lastcontacttime:yyyy-mm-dd HH:MM; yyyy-mm-dd HH:MM  :- example ['lastcontacttime':2015-06-14 13:00;2015-06-15 13:00] this will count from date 2015-06-14 13:00 till date 2015-06-15 13:00.
  *                4. lastcontacttime:*;*  :- example ['lastcontacttime':*;*] this will count all devices.


- api owner enabled <true|false> (default false)

  Enable NSO Service Ownership.


- api owner is <string>

  Default Service Name.
```

### 4.1. ned-settings tilgin-tgem api request error-handling silent-mechanism silent-error

***

```
- api request error-handling silent-mechanism silent-error <idx> <message>

  - idx <uint32>

  - message <string>

    Failed request error message to match for not throwing an exception.
```

### 4.2. ned-settings tilgin-tgem api request retry-mechanism retriable-error

***

```
- api request retry-mechanism retriable-error <idx> <message>

  - idx <uint32>

  - message <string>

    Error message to match for retrying the request.
```

### 4.3. ned-settings tilgin-tgem api sync devices info

***

Configure which Device info to be retrieved from the API.

```
- api sync devices info <name> <enabled>

  - name <enum>

    oui     - oui.

    serial  - serial.

    status  - status.

    mac     - mac.

  - enabled <true|false> (default false)
```

### 4.4. ned-settings tilgin-tgem api owner of device

***

```
- api owner of device <uid> <is>

  - uid <string>

    oui-serial.

  - is <string>

    Service Name.
```

## 5. ned-settings tilgin-tgem developer

***

Contains settings used by the NED developers.

```
- developer trace-enable <true|false> (default false)

  Enable developer tracing. WARNING: may choke NSO with large commits|systems.


- developer trace-connection <true|false> (default false)

  Enable connection tracing. WARNING: may choke NSO with IPC messages.


- developer trace-timestamp <true|false> (default false)

  Add timestamp from NED instance in trace messages for debug purpose.


- developer platform model <string>

  Override device model name/number.


- developer platform name <string>

  Override device name.


- developer platform version <string>

  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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://nso-docs.cisco.com/neds/cisco-provided-neds/tilgin-tgem/readme-ned-settings.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
