From 8f2d46ecf86bd2159bae0fef9fc9c90dd6755173 Mon Sep 17 00:00:00 2001 From: Ganesh Nalawade Date: Tue, 17 Apr 2018 11:58:40 +0530 Subject: [PATCH] Add supported connection in junos module documentation (#38813) (#38865) * Add supported connection in junos module documentation Add supported connection type in junos module doucmentation. * adds link to platform docs * makes recommended connection a code snippet * does this fix banner and command? * does this fix the rest of the errors? (cherry picked from commit 67d561b0c8dc30490be13603e431a709079f3e50) --- changelogs/fragments/junos_module_doc_fixes.yaml | 2 ++ lib/ansible/modules/network/junos/junos_banner.py | 2 ++ lib/ansible/modules/network/junos/junos_command.py | 2 ++ lib/ansible/modules/network/junos/junos_config.py | 2 ++ lib/ansible/modules/network/junos/junos_facts.py | 2 ++ lib/ansible/modules/network/junos/junos_interface.py | 2 ++ lib/ansible/modules/network/junos/junos_l2_interface.py | 2 ++ lib/ansible/modules/network/junos/junos_l3_interface.py | 2 ++ lib/ansible/modules/network/junos/junos_linkagg.py | 2 ++ lib/ansible/modules/network/junos/junos_lldp.py | 2 ++ lib/ansible/modules/network/junos/junos_lldp_interface.py | 2 ++ lib/ansible/modules/network/junos/junos_logging.py | 2 ++ lib/ansible/modules/network/junos/junos_netconf.py | 2 ++ lib/ansible/modules/network/junos/junos_package.py | 1 + lib/ansible/modules/network/junos/junos_rpc.py | 2 ++ lib/ansible/modules/network/junos/junos_scp.py | 1 + lib/ansible/modules/network/junos/junos_static_route.py | 2 ++ lib/ansible/modules/network/junos/junos_system.py | 2 ++ lib/ansible/modules/network/junos/junos_user.py | 2 ++ lib/ansible/modules/network/junos/junos_vlan.py | 2 ++ lib/ansible/modules/network/junos/junos_vrf.py | 2 ++ 21 files changed, 40 insertions(+) create mode 100644 changelogs/fragments/junos_module_doc_fixes.yaml diff --git a/changelogs/fragments/junos_module_doc_fixes.yaml b/changelogs/fragments/junos_module_doc_fixes.yaml new file mode 100644 index 00000000000..fce49f86e8b --- /dev/null +++ b/changelogs/fragments/junos_module_doc_fixes.yaml @@ -0,0 +1,2 @@ +bugfixes: +- Add supported connection in junos module documentation (https://github.com/ansible/ansible/pull/38813) diff --git a/lib/ansible/modules/network/junos/junos_banner.py b/lib/ansible/modules/network/junos/junos_banner.py index dd3f8ef95a2..42ee6cd7e88 100644 --- a/lib/ansible/modules/network/junos/junos_banner.py +++ b/lib/ansible/modules/network/junos/junos_banner.py @@ -54,6 +54,8 @@ notes: - This module requires the netconf system service be enabled on the remote device being managed. - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. + - Recommended connection is C(netconf). See L(the Junos OS Platform Options,../network/user_guide/platform_junos.html). + - This module also works with C(local) connections for legacy playbooks. extends_documentation_fragment: junos """ diff --git a/lib/ansible/modules/network/junos/junos_command.py b/lib/ansible/modules/network/junos/junos_command.py index cc8ae319019..81c2d7f0f1d 100644 --- a/lib/ansible/modules/network/junos/junos_command.py +++ b/lib/ansible/modules/network/junos/junos_command.py @@ -102,6 +102,8 @@ notes: - This module requires the netconf system service be enabled on the remote device being managed. - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. + - Recommended connection is C(netconf). See L(the Junos OS Platform Options,../network/user_guide/platform_junos.html). + - This module also works with C(network_cli) connections and with C(local) connections for legacy playbooks. """ EXAMPLES = """ diff --git a/lib/ansible/modules/network/junos/junos_config.py b/lib/ansible/modules/network/junos/junos_config.py index 7bc23605021..e1cbf5bff21 100644 --- a/lib/ansible/modules/network/junos/junos_config.py +++ b/lib/ansible/modules/network/junos/junos_config.py @@ -146,6 +146,8 @@ notes: - Loading JSON-formatted configuration I(json) is supported starting in Junos OS Release 16.1 onwards. - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. + - Recommended connection is C(netconf). See L(the Junos OS Platform Options,../network/user_guide/platform_junos.html). + - This module also works with C(local) connections for legacy playbooks. """ EXAMPLES = """ diff --git a/lib/ansible/modules/network/junos/junos_facts.py b/lib/ansible/modules/network/junos/junos_facts.py index 62aab0b9c45..22bf2487609 100644 --- a/lib/ansible/modules/network/junos/junos_facts.py +++ b/lib/ansible/modules/network/junos/junos_facts.py @@ -60,6 +60,8 @@ notes: - This module requires the netconf system service be enabled on the remote device being managed. - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. + - Recommended connection is C(netconf). See L(the Junos OS Platform Options,../network/user_guide/platform_junos.html). + - This module also works with C(local) connections for legacy playbooks. """ EXAMPLES = """ diff --git a/lib/ansible/modules/network/junos/junos_interface.py b/lib/ansible/modules/network/junos/junos_interface.py index b63b8e9d1bd..aecf914a65f 100644 --- a/lib/ansible/modules/network/junos/junos_interface.py +++ b/lib/ansible/modules/network/junos/junos_interface.py @@ -90,6 +90,8 @@ notes: - This module requires the netconf system service be enabled on the remote device being managed. - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. + - Recommended connection is C(netconf). See L(the Junos OS Platform Options,../network/user_guide/platform_junos.html). + - This module also works with C(local) connections for legacy playbooks. extends_documentation_fragment: junos """ diff --git a/lib/ansible/modules/network/junos/junos_l2_interface.py b/lib/ansible/modules/network/junos/junos_l2_interface.py index 53ae7689d37..23de9b19156 100644 --- a/lib/ansible/modules/network/junos/junos_l2_interface.py +++ b/lib/ansible/modules/network/junos/junos_l2_interface.py @@ -69,6 +69,8 @@ notes: - This module requires the netconf system service be enabled on the remote device being managed. - Tested against vqfx-10000 JUNOS Version 15.1X53-D60.4. + - Recommended connection is C(netconf). See L(the Junos OS Platform Options,../network/user_guide/platform_junos.html). + - This module also works with C(local) connections for legacy playbooks. extends_documentation_fragment: junos """ diff --git a/lib/ansible/modules/network/junos/junos_l3_interface.py b/lib/ansible/modules/network/junos/junos_l3_interface.py index e7f588d9154..765258bd84c 100644 --- a/lib/ansible/modules/network/junos/junos_l3_interface.py +++ b/lib/ansible/modules/network/junos/junos_l3_interface.py @@ -54,6 +54,8 @@ notes: - This module requires the netconf system service be enabled on the remote device being managed. - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. + - Recommended connection is C(netconf). See L(the Junos OS Platform Options,../network/user_guide/platform_junos.html). + - This module also works with C(local) connections for legacy playbooks. extends_documentation_fragment: junos """ diff --git a/lib/ansible/modules/network/junos/junos_linkagg.py b/lib/ansible/modules/network/junos/junos_linkagg.py index 2c9774f6e94..85ad8481c0c 100644 --- a/lib/ansible/modules/network/junos/junos_linkagg.py +++ b/lib/ansible/modules/network/junos/junos_linkagg.py @@ -69,6 +69,8 @@ notes: - This module requires the netconf system service be enabled on the remote device being managed. - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. + - Recommended connection is C(netconf). See L(the Junos OS Platform Options,../network/user_guide/platform_junos.html). + - This module also works with C(local) connections for legacy playbooks. extends_documentation_fragment: junos """ diff --git a/lib/ansible/modules/network/junos/junos_lldp.py b/lib/ansible/modules/network/junos/junos_lldp.py index 063800a4bf9..989dbe5f71a 100644 --- a/lib/ansible/modules/network/junos/junos_lldp.py +++ b/lib/ansible/modules/network/junos/junos_lldp.py @@ -56,6 +56,8 @@ notes: - This module requires the netconf system service be enabled on the remote device being managed. - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. + - Recommended connection is C(netconf). See L(the Junos OS Platform Options,../network/user_guide/platform_junos.html). + - This module also works with C(local) connections for legacy playbooks. extends_documentation_fragment: junos """ diff --git a/lib/ansible/modules/network/junos/junos_lldp_interface.py b/lib/ansible/modules/network/junos/junos_lldp_interface.py index 54228b7c671..a5c90b4469e 100644 --- a/lib/ansible/modules/network/junos/junos_lldp_interface.py +++ b/lib/ansible/modules/network/junos/junos_lldp_interface.py @@ -45,6 +45,8 @@ notes: - This module requires the netconf system service be enabled on the remote device being managed. - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. + - Recommended connection is C(netconf). See L(the Junos OS Platform Options,../network/user_guide/platform_junos.html). + - This module also works with C(local) connections for legacy playbooks. extends_documentation_fragment: junos """ diff --git a/lib/ansible/modules/network/junos/junos_logging.py b/lib/ansible/modules/network/junos/junos_logging.py index 825da3ed734..afc8a422ca2 100644 --- a/lib/ansible/modules/network/junos/junos_logging.py +++ b/lib/ansible/modules/network/junos/junos_logging.py @@ -73,6 +73,8 @@ notes: - This module requires the netconf system service be enabled on the remote device being managed. - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. + - Recommended connection is C(netconf). See L(the Junos OS Platform Options,../network/user_guide/platform_junos.html). + - This module also works with C(local) connections for legacy playbooks. extends_documentation_fragment: junos """ diff --git a/lib/ansible/modules/network/junos/junos_netconf.py b/lib/ansible/modules/network/junos/junos_netconf.py index 6b085e4c57d..b12a6d10576 100644 --- a/lib/ansible/modules/network/junos/junos_netconf.py +++ b/lib/ansible/modules/network/junos/junos_netconf.py @@ -48,6 +48,8 @@ options: choices: ['present', 'absent'] notes: - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. + - Recommended connection is C(network_cli). See L(the Junos OS Platform Options,../network/user_guide/platform_junos.html). + - This module also works with C(local) connections for legacy playbooks. """ EXAMPLES = """ diff --git a/lib/ansible/modules/network/junos/junos_package.py b/lib/ansible/modules/network/junos/junos_package.py index fcaae78ad92..19998a01797 100644 --- a/lib/ansible/modules/network/junos/junos_package.py +++ b/lib/ansible/modules/network/junos/junos_package.py @@ -86,6 +86,7 @@ notes: - This module requires the netconf system service be enabled on the remote device being managed. - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. + - Works with C(local) connections only. """ EXAMPLES = """ diff --git a/lib/ansible/modules/network/junos/junos_rpc.py b/lib/ansible/modules/network/junos/junos_rpc.py index c231153f637..bc19edfb5ef 100644 --- a/lib/ansible/modules/network/junos/junos_rpc.py +++ b/lib/ansible/modules/network/junos/junos_rpc.py @@ -58,6 +58,8 @@ notes: - This module requires the netconf system service be enabled on the remote device being managed. - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. + - Recommended connection is C(netconf). See L(the Junos OS Platform Options,../network/user_guide/platform_junos.html). + - This module also works with C(local) connections for legacy playbooks. """ EXAMPLES = """ diff --git a/lib/ansible/modules/network/junos/junos_scp.py b/lib/ansible/modules/network/junos/junos_scp.py index e03f71aafaa..b85d652e509 100644 --- a/lib/ansible/modules/network/junos/junos_scp.py +++ b/lib/ansible/modules/network/junos/junos_scp.py @@ -58,6 +58,7 @@ notes: - This module requires the netconf system service be enabled on the remote device being managed. - Tested against vMX JUNOS version 17.3R1.10. + - Works with C(local) connections only. """ EXAMPLES = """ diff --git a/lib/ansible/modules/network/junos/junos_static_route.py b/lib/ansible/modules/network/junos/junos_static_route.py index d8a942d4201..75465d051a9 100644 --- a/lib/ansible/modules/network/junos/junos_static_route.py +++ b/lib/ansible/modules/network/junos/junos_static_route.py @@ -61,6 +61,8 @@ notes: - This module requires the netconf system service be enabled on the remote device being managed. - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. + - Recommended connection is C(netconf). See L(the Junos OS Platform Options,../network/user_guide/platform_junos.html). + - This module also works with C(local) connections for legacy playbooks. extends_documentation_fragment: junos """ diff --git a/lib/ansible/modules/network/junos/junos_system.py b/lib/ansible/modules/network/junos/junos_system.py index 80fdba5fa95..39702572c14 100644 --- a/lib/ansible/modules/network/junos/junos_system.py +++ b/lib/ansible/modules/network/junos/junos_system.py @@ -66,6 +66,8 @@ notes: - This module requires the netconf system service be enabled on the remote device being managed. - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. + - Recommended connection is C(netconf). See L(the Junos OS Platform Options,../network/user_guide/platform_junos.html). + - This module also works with C(local) connections for legacy playbooks. extends_documentation_fragment: junos """ diff --git a/lib/ansible/modules/network/junos/junos_user.py b/lib/ansible/modules/network/junos/junos_user.py index f936ff85e09..94863577dd2 100644 --- a/lib/ansible/modules/network/junos/junos_user.py +++ b/lib/ansible/modules/network/junos/junos_user.py @@ -96,6 +96,8 @@ notes: - This module requires the netconf system service be enabled on the remote device being managed. - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. + - Recommended connection is C(netconf). See L(the Junos OS Platform Options,../network/user_guide/platform_junos.html). + - This module also works with C(local) connections for legacy playbooks. """ EXAMPLES = """ diff --git a/lib/ansible/modules/network/junos/junos_vlan.py b/lib/ansible/modules/network/junos/junos_vlan.py index 5bf2e1447c3..a9230bf4e1a 100644 --- a/lib/ansible/modules/network/junos/junos_vlan.py +++ b/lib/ansible/modules/network/junos/junos_vlan.py @@ -55,6 +55,8 @@ notes: - This module requires the netconf system service be enabled on the remote device being managed. - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. + - Recommended connection is C(netconf). See L(the Junos OS Platform Options,../network/user_guide/platform_junos.html). + - This module also works with C(local) connections for legacy playbooks. extends_documentation_fragment: junos """ diff --git a/lib/ansible/modules/network/junos/junos_vrf.py b/lib/ansible/modules/network/junos/junos_vrf.py index 3dfaaf4eae2..a5eacc6ee70 100644 --- a/lib/ansible/modules/network/junos/junos_vrf.py +++ b/lib/ansible/modules/network/junos/junos_vrf.py @@ -80,6 +80,8 @@ notes: - This module requires the netconf system service be enabled on the remote device being managed. - Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4. + - Recommended connection is C(netconf). See L(the Junos OS Platform Options,../network/user_guide/platform_junos.html). + - This module also works with C(local) connections for legacy playbooks. extends_documentation_fragment: junos """