Skip to content

NMS-16237: add support for RFC2348 "TFTP blksize" to the tftp implementation #8184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
dino2gnt wants to merge 6 commits into
base: release-35.x
Choose a base branch
from
Open

NMS-16237: add support for RFC2348 "TFTP blksize" to the tftp implementation #8184

dino2gnt wants to merge 6 commits into from

Conversation

@dino2gnt
Copy link
Contributor

@dino2gnt dino2gnt commented Dec 6, 2025 •
edited
Loading

This also:

  • Adds additional debug logging to aid in troubleshooting DCB issues (failing silently sucks) <1>
  • Adds quality-of-life improvements for how ${filenameSuffix} is checked (endwith() / contains())
  • Bumps commons.net to 3.12.0

Happy to re-target to a different branch if y'all think this is simple enough to go back into other Meridians, otherwise i think this will get it into Horizon 35 and Meridian 2026 ?

Pretty limited blast radius either way.

1>

2025-12-06T15:39:58,798 | DEBUG | pool-19-thread-4 | RetrieverImpl                    | 339 - org.opennms.features.device-config.retrieval - 34.0.1 | retrieve config: /192.168.69.74:22
2025-12-06T15:39:58,799 | INFO  | pool-19-thread-4 | TftpServerImpl                   | 345 - org.opennms.features.device-config.tftp - 34.0.1 | Starting TFTP Server on port 69
2025-12-06T15:39:58,803 | INFO  | pool-19-thread-4 | TftpServerImpl                   | 345 - org.opennms.features.device-config.tftp - 34.0.1 | Registered new TFTP receiver, current receiver count 1
2025-12-06T15:39:58,804 | DEBUG | pool-19-thread-4 | DeviceConfigMonitor              | 337 - org.opennms.features.device-config.monitor - 34.0.1 | Starting retrieval, waiting at most 60000 milliseconds
2025-12-06T15:39:59,552 | DEBUG | Thread-236       | SshScriptingServiceImpl          | 344 - org.opennms.features.device-config.ssh-scripting - 34.0.1 | ssh connection successful, executing script: await: ]$\nsend: echo "HELLO!"\nsend: /usr/bin/atftp --trace --option "blksize 1024" --put -l hosts -r hosts-${filenameSuffix}.cfg ${tftpServerIp} ${tftpServerPort}\nawait: ]$\nsend: exit\n
2025-12-06T15:39:59,552 | DEBUG | Thread-236       | SshScriptingServiceImpl          | 344 - org.opennms.features.device-config.ssh-scripting - 34.0.1 | ssh scripting service executing - await: ]$
2025-12-06T15:40:00,553 | DEBUG | Thread-236       | SshScriptingServiceImpl          | 344 - org.opennms.features.device-config.ssh-scripting - 34.0.1 | ssh scripting service executing - send: echo "HELLO!"
2025-12-06T15:40:00,554 | DEBUG | Thread-236       | SshScriptingServiceImpl          | 344 - org.opennms.features.device-config.ssh-scripting - 34.0.1 | ssh scripting service executing - send: /usr/bin/atftp --trace --option "blksize 1024" --put -l hosts -r hosts-3gDzvpsoSpmNzsa9r_r0-Q-monitor.cfg 192.168.69.121 69
2025-12-06T15:40:00,554 | DEBUG | Thread-236       | SshScriptingServiceImpl          | 344 - org.opennms.features.device-config.ssh-scripting - 34.0.1 | ssh scripting service executing - await: ]$
2025-12-06T15:40:00,561 | DEBUG | Thread-238       | TftpServerImpl                   | 345 - org.opennms.features.device-config.tftp - 34.0.1 | Received write request from client '/192.168.69.74'
2025-12-06T15:40:00,561 | DEBUG | Thread-238       | TftpServerImpl                   | 345 - org.opennms.features.device-config.tftp - 34.0.1 | Received blksize option from client '/192.168.69.74', attempting negotiation
2025-12-06T15:40:00,561 | DEBUG | Thread-238       | TftpServerImpl                   | 345 - org.opennms.features.device-config.tftp - 34.0.1 | Negotiating tftp blksize '1024' with client '/192.168.69.74'
2025-12-06T15:40:00,562 | DEBUG | Thread-238       | TftpServerImpl                   | 345 - org.opennms.features.device-config.tftp - 34.0.1 | Successfully negotiated blksize '1024' with client '/192.168.69.74'
2025-12-06T15:40:00,563 | DEBUG | Thread-238       | TftpServerImpl                   | 345 - org.opennms.features.device-config.tftp - 34.0.1 | Processing block 1 from client '/192.168.69.74'
2025-12-06T15:40:00,563 | DEBUG | Thread-238       | TftpServerImpl                   | 345 - org.opennms.features.device-config.tftp - 34.0.1 | Sending Ack for block 1 from client '/192.168.69.74'
2025-12-06T15:40:00,563 | DEBUG | Thread-238       | TftpServerImpl                   | 345 - org.opennms.features.device-config.tftp - 34.0.1 | Processing block 2 from client '/192.168.69.74'
2025-12-06T15:40:00,564 | DEBUG | Thread-238       | TftpServerImpl                   | 345 - org.opennms.features.device-config.tftp - 34.0.1 | Sending Ack for block 2 from client '/192.168.69.74'
2025-12-06T15:40:00,566 | DEBUG | Thread-238       | TftpServerImpl                   | 345 - org.opennms.features.device-config.tftp - 34.0.1 | Processing block 3 from client '/192.168.69.74'
2025-12-06T15:40:00,566 | DEBUG | Thread-238       | TftpServerImpl                   | 345 - org.opennms.features.device-config.tftp - 34.0.1 | Sending Ack for block 3 from client '/192.168.69.74'
2025-12-06T15:40:00,569 | DEBUG | Thread-238       | TftpServerImpl                   | 345 - org.opennms.features.device-config.tftp - 34.0.1 | Processing block 4 from client '/192.168.69.74'
2025-12-06T15:40:00,569 | DEBUG | Thread-238       | TftpServerImpl                   | 345 - org.opennms.features.device-config.tftp - 34.0.1 | Sending Ack for block 4 from client '/192.168.69.74'
2025-12-06T15:40:00,574 | DEBUG | Thread-238       | TftpServerImpl                   | 345 - org.opennms.features.device-config.tftp - 34.0.1 | Processing block 5 from client '/192.168.69.74'
2025-12-06T15:40:00,576 | DEBUG | Thread-238       | TftpServerImpl                   | 345 - org.opennms.features.device-config.tftp - 34.0.1 | Sending Ack for block 5 from client '/192.168.69.74'
2025-12-06T15:40:00,578 | DEBUG | Thread-238       | RetrieverImpl                    | 339 - org.opennms.features.device-config.retrieval - 34.0.1 | received config - target: /192.168.69.74:22; address: 192.168.69.74
2025-12-06T15:40:01,555 | DEBUG | Thread-236       | SshScriptingServiceImpl          | 344 - org.opennms.features.device-config.ssh-scripting - 34.0.1 | ssh scripting service executing - send: exit
2025-12-06T15:40:01,561 | INFO  | Thread-238       | TftpServerImpl                   | 345 - org.opennms.features.device-config.tftp - 34.0.1 | Unregistered TFTP receiver, current receiver count 0
2025-12-06T15:40:01,562 | INFO  | Thread-238       | TftpServerImpl                   | 345 - org.opennms.features.device-config.tftp - 34.0.1 | No receivers exist currently, closing the tftp server
2025-12-06T15:40:01,562 | DEBUG | Thread-238       | DeviceConfigMonitor              | 337 - org.opennms.features.device-config.monitor - 34.0.1 | Retrieved device configuration - target: /192.168.69.74:22

External References

@marshallmassengill
Copy link
Contributor

marshallmassengill commented Dec 8, 2025

I've tested this in my lab and things seem to be working as expected. I think I would target this at 2025 or maybe even 2024? It's a pretty minimal change but it's a good quality of life improvement for the feature.

I would suggest we tweak the docs for this a bit too explaining that suffix variable a bit if nothing else and mentioning the support for RFC2348.

marshallmassengill
marshallmassengill previously approved these changes Dec 8, 2025
View reviewed changes
Copy link
Contributor

@marshallmassengill marshallmassengill left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code changes look good. See my comments for other notes.

@dino2gnt
Copy link
Contributor Author

dino2gnt commented Dec 8, 2025 •
edited
Loading

I would suggest we tweak the docs for this a bit too explaining that suffix variable a bit

I changed the behavior, now no matter how the user interprets the ${filenameSuffix} requirement (end of the full filename, end of the filename but before the file extension, something else), it'll be accepted. Docs can remain unclear 😆

cgorantla
cgorantla requested changes Dec 8, 2025
View reviewed changes
@dino2gnt @cgorantla
Update features/device-config/tftp/src/main/java/org/opennms/features…
17583af 
…/deviceconfig/tftp/impl/TftpServerImpl.java


no fun :/

Co-authored-by: Chandra Gorantla <chandra@opennms.com>
cgorantla
cgorantla reviewed Dec 8, 2025
View reviewed changes
...ce-config/tftp/src/main/java/org/opennms/features/deviceconfig/tftp/impl/TftpServerImpl.java
try {
int localPort = transferTftp_.getLocalPort();
transferTftp_.close();
while (true) {
Copy link
Contributor

@cgorantla cgorantla Dec 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't think we should while(true) loops.

Let me try this differently.

Copy link
Contributor Author

@dino2gnt dino2gnt Dec 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't feel good about it either.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cgorantla cgorantla cgorantla requested changes

@marshallmassengill marshallmassengill marshallmassengill left review comments

@indigo423 indigo423 Awaiting requested review from indigo423

@synqotik synqotik Awaiting requested review from synqotik

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dino2gnt @marshallmassengill @cgorantla