-
Notifications
You must be signed in to change notification settings - Fork 338
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.
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
Implement SSH keepalives, default 30-second interval, for NETCONF over SSH sessions. #668
Open
stacywsmith
wants to merge
6
commits into
Juniper:master
Choose a base branch
from
stacywsmith:ssh-keepalives
base: master
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
fa8fc12
Implement SSH keepalives, with a default 30-second interval, for NETC…
stacywsmith fbfeda0
Ensure the value passed to Paramiko is an integer.
stacywsmith 07cd679
Merge branch 'master' into ssh-keepalives
4484693
Merge branch 'master' into ssh-keepalives
rahkumar651991 4e01265
format file for black tool changes.
rahkumar651991 6d5f000
format file for black tool recommendation
rahkumar651991 File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -866,6 +866,16 @@ def __init__(self, *vargs, **kvargs): | |
This can be used to load SSH information from a configuration file. | ||
By default ~/.ssh/config is queried. | ||
|
||
:param int ssh_keepalives: | ||
*OPTIONAL* The interval, in seconds, at which to send SSH | ||
keepalives for the NETCONF over SSH session. Without SSH | ||
keepalives, a NAT or stateful firewall along the network | ||
path between the PyEZ host and the target Junos device, | ||
may timeout an inactive TCP flow and cause the NETCONF over SSH | ||
session to hang. Sending SSH keepalives avoids this situation. The | ||
default value is 30 seconds. Setting this parameter to a value of 0 | ||
disables SSH keepalives. | ||
|
||
:param bool normalize: | ||
*OPTIONAL* default is ``False``. If ``True`` then the | ||
XML returned by :meth:`execute` will have whitespace normalized | ||
|
@@ -897,6 +907,7 @@ def __init__(self, *vargs, **kvargs): | |
self._hostname = 'localhost' | ||
self._ssh_private_key_file = None | ||
self._ssh_config = None | ||
self._ssh_keepalives = None | ||
else: | ||
# -------------------------- | ||
# making a remote connection | ||
|
@@ -910,6 +921,7 @@ def __init__(self, *vargs, **kvargs): | |
self._conf_ssh_private_key_file = None | ||
# user can get updated by ssh_config | ||
self._ssh_config = kvargs.get('ssh_config') | ||
self._ssh_keepalives = kvargs.get('ssh_keepalives', 30) | ||
self._sshconf_lkup() | ||
# but if user or private key is explicit from call, then use it. | ||
self._auth_user = kvargs.get('user') or self._conf_auth_user or \ | ||
|
@@ -1008,6 +1020,9 @@ def open(self, *vargs, **kvargs): | |
ssh_config=self._sshconf_lkup(), | ||
device_params={'name': 'junos', 'local': False}) | ||
|
||
self._conn._session.transport.set_keepalive( | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. line 910 we are setting it to None for on-box if condition. So on on-box are not reaching line 924, hence converting None to int at line 1024 will throw exception. |
||
int(self._ssh_keepalives)) | ||
|
||
except NcErrors.AuthenticationError as err: | ||
# bad authentication credentials | ||
raise EzErrors.ConnectAuthError(self) | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Setting this to
None
does not make sense. This value is initialized to zero in the underlying module.Help on method set_keepalive in module paramiko.transport:
set_keepalive(self, interval) method of paramiko.transport.Transport instance
Turn on/off keepalive packets (default is off). If this is set, after
interval
seconds without sending any data over the connection, a"keepalive" packet will be sent (and ignored by the remote host). This
can be useful to keep connections alive over a NAT, for example.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
None is set for on-box python, where it won't use ssh connection. So this should be OK