TP-Link Configuration

The tplink model is used for TP-Link JetStream managed switches and the DeltaStream GPON OLT. The notes below apply to all of them.

SSH authentication: avoid public-key authentication

Some TP-Link devices (the DeltaStream GPON OLT for example) abort the SSH connection if the client attempts public-key authentication before the password. By default net-ssh offers any key from the SSH agent or the default identity files first, so when the Oxidized host has SSH keys the device closes the connection before the password is ever tried:

connection closed by remote host (Net::SSH::Disconnect)

This is why the same device may connect fine from one host (no SSH keys) and fail from another (keys present). Tell Oxidized to skip publickey with the auth_methods variable (see SSH Auth Methods). It can be set globally, by group, by model or by node, e.g. for every tplink device:

models:
  tplink:
    vars:
      auth_methods: ["none", "password"]

Capturing a simulation with device2yaml.rb

extra/device2yaml.rb has no auth_methods option, but net-ssh reads ~/.ssh/config, so add a host block for the device to force password authentication:

Host <device-ip>
    PreferredAuthentications password
    PubkeyAuthentication no

This CLI also submits a command only on a carriage return, so run device2yaml with -n '\r\n'; otherwise the commands are echoed but never executed.

Enable mode

Devices such as the DeltaStream GPON OLT only expose their configuration in privileged (enable) mode. The model enters enable mode through the standard enable variable:

• enable: true — switch to enable with no password (TP-Link devices enable without a password by default).
• enable: <password> — switch to enable and send <password> when prompted.

Set it globally, per model or per node, e.g. in the configuration:

models:
  tplink:
    vars:
      enable: true

or as the 6th column of a CSV router.db line (the CSV source maps the string true to the boolean true):

tplink-olt:tplink:10.0.0.1:admin:secret:true

Without the enable variable the model stays in user mode (>) and privileged commands return Error: Bad command.

Back to Model-Notes