summaryrefslogtreecommitdiff
path: root/docs/docsite
diff options
context:
space:
mode:
authorSandra McCann <samccann@redhat.com>2018-07-20 11:22:30 -0400
committerSandra McCann <samccann@redhat.com>2018-07-20 11:22:30 -0400
commit2e93eab9205ea4bc2af37ecba748431898691594 (patch)
tree4165aad2e5619e9fcb6e33f39a7b099c73083a75 /docs/docsite
parentdba975470d0468ddaa8268d96f65f4cbf94434bf (diff)
parent78b1980474d92479762f260d0395834fe3d0fa08 (diff)
downloadansible-2e93eab9205ea4bc2af37ecba748431898691594.tar.gz
pr 42271 - fixed merge conflicts
Diffstat (limited to 'docs/docsite')
-rw-r--r--docs/docsite/rst/network/user_guide/network_debug_troubleshooting.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/docsite/rst/network/user_guide/network_debug_troubleshooting.rst b/docs/docsite/rst/network/user_guide/network_debug_troubleshooting.rst
index f7c36f812e..7323d487c0 100644
--- a/docs/docsite/rst/network/user_guide/network_debug_troubleshooting.rst
+++ b/docs/docsite/rst/network/user_guide/network_debug_troubleshooting.rst
@@ -597,6 +597,46 @@ no additional changes necessary. The network module will now connect to the
network device by first connecting to the host specified in
``ansible_ssh_common_args``, which is ``bastion01`` in the above example.
+Using bastion/jump host with netconf connection
+-----------------------------------------------
+
+Enabling jump host setting
+--------------------------
+
+Bastion/jump host with netconf connection can be enable using
+- Setting Ansible variable``ansible_netconf_ssh_config`` either to ``True`` or custom ssh config file path
+- Setting environment variable ``ANSIBLE_NETCONF_SSH_CONFIG`` to ``True`` or custom ssh config file path
+- Setting ``ssh_config = 1`` or ``ssh_config = <ssh-file-path>``under ``netconf_connection`` section
+
+If the configuration variable is set to 1 the proxycommand and other ssh variables are read from
+default ssh config file (~/.ssh/config).
+If the configuration variable is set to file path the proxycommand and other ssh variables are read
+from the given custom ssh file path
+
+Example ssh config file (~/.ssh/config)
+---------------------------------------
+
+.. code-block:: ini
+
+ Host junos01
+ HostName junos01
+ User myuser
+
+ ProxyCommand ssh user@bastion01 nc %h %p %r
+
+Example Ansible inventory file
+
+.. code-block:: ini
+
+ [junos]
+ junos01
+
+ [junos:vars]
+ ansible_connection=netconf
+ ansible_network_os=junos
+ ansible_user=myuser
+ ansible_ssh_pass=!vault...
+
.. note:: Using ``ProxyCommand`` with passwords via variables