From 290e63aba504ee7c1cbb6d447f8b21d9aab8e059 Mon Sep 17 00:00:00 2001 From: Xu Yuandong Date: Wed, 20 Nov 2019 01:36:06 +0800 Subject: [PATCH] Backport/2.8/64351 Doc notes 6 (#64351) (#64945) * Doc notes 6 (#64351) (cherry picked from commit 25e03b1e75c0c5e0a38a7af1829593001bddddcb) * add a changelog --- changelogs/fragments/64945_update_modules_docs_notes.yml | 3 +++ lib/ansible/modules/network/cloudengine/ce_vlan.py | 4 ++++ lib/ansible/modules/network/cloudengine/ce_vrf.py | 6 ++++-- lib/ansible/modules/network/cloudengine/ce_vrf_af.py | 6 ++++-- lib/ansible/modules/network/cloudengine/ce_vrf_interface.py | 3 +++ lib/ansible/modules/network/cloudengine/ce_vrrp.py | 4 ++++ lib/ansible/modules/network/cloudengine/ce_vxlan_arp.py | 3 +++ lib/ansible/modules/network/cloudengine/ce_vxlan_gateway.py | 2 ++ lib/ansible/modules/network/cloudengine/ce_vxlan_global.py | 3 +++ lib/ansible/modules/network/cloudengine/ce_vxlan_tunnel.py | 4 ++++ lib/ansible/modules/network/cloudengine/ce_vxlan_vap.py | 4 ++++ 11 files changed, 38 insertions(+), 4 deletions(-) create mode 100644 changelogs/fragments/64945_update_modules_docs_notes.yml diff --git a/changelogs/fragments/64945_update_modules_docs_notes.yml b/changelogs/fragments/64945_update_modules_docs_notes.yml new file mode 100644 index 00000000000..552ec45d0e1 --- /dev/null +++ b/changelogs/fragments/64945_update_modules_docs_notes.yml @@ -0,0 +1,3 @@ +--- +bugfixes: + - ce modules - Update(add) docs notes to tell user modules work connection. diff --git a/lib/ansible/modules/network/cloudengine/ce_vlan.py b/lib/ansible/modules/network/cloudengine/ce_vlan.py index 6e54a1b3364..dbcaefcf7eb 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vlan.py +++ b/lib/ansible/modules/network/cloudengine/ce_vlan.py @@ -28,6 +28,10 @@ short_description: Manages VLAN resources and attributes on Huawei CloudEngine s description: - Manages VLAN configurations on Huawei CloudEngine switches. author: QijunPan (@QijunPan) +notes: + - This module requires the netconf system service be enabled on the remote device being managed. + - Recommended connection is C(netconf). + - This module also works with C(local) connections for legacy playbooks. options: vlan_id: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_vrf.py b/lib/ansible/modules/network/cloudengine/ce_vrf.py index 3afc72dd3b7..8b4a6b3da62 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vrf.py +++ b/lib/ansible/modules/network/cloudengine/ce_vrf.py @@ -29,8 +29,10 @@ description: - Manages VPN instance of HUAWEI CloudEngine switches. author: Yang yang (@QijunPan) notes: - - If I(state=absent), the route will be removed, regardless of the - non-required options. + - If I(state=absent), the route will be removed, regardless of the non-required options. + - This module requires the netconf system service be enabled on the remote device being managed. + - Recommended connection is C(netconf). + - This module also works with C(local) connections for legacy playbooks. options: vrf: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_vrf_af.py b/lib/ansible/modules/network/cloudengine/ce_vrf_af.py index c89ed2c5f58..9237c8ad5b5 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vrf_af.py +++ b/lib/ansible/modules/network/cloudengine/ce_vrf_af.py @@ -27,8 +27,10 @@ description: - Manages VPN instance address family of HUAWEI CloudEngine switches. author: Yang yang (@QijunPan) notes: - - If I(state=absent), the vrf will be removed, regardless of the - non-required parameters. + - If I(state=absent), the vrf will be removed, regardless of the non-required parameters. + - This module requires the netconf system service be enabled on the remote device being managed. + - Recommended connection is C(netconf). + - This module also works with C(local) connections for legacy playbooks. options: vrf: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_vrf_interface.py b/lib/ansible/modules/network/cloudengine/ce_vrf_interface.py index 8037d490ed9..c13a7efd173 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vrf_interface.py +++ b/lib/ansible/modules/network/cloudengine/ce_vrf_interface.py @@ -30,6 +30,9 @@ description: author: Zhijin Zhou (@QijunPan) notes: - Ensure that a VPN instance has been created and the IPv4 address family has been enabled for the VPN instance. + - This module requires the netconf system service be enabled on the remote device being managed. + - Recommended connection is C(netconf). + - This module also works with C(local) connections for legacy playbooks. options: vrf: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_vrrp.py b/lib/ansible/modules/network/cloudengine/ce_vrrp.py index b69ae37b239..1ecf4b5c3f6 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vrrp.py +++ b/lib/ansible/modules/network/cloudengine/ce_vrrp.py @@ -29,6 +29,10 @@ description: - Manages VRRP interface attributes on HUAWEI CloudEngine devices. author: - Li Yanfeng (@numone213) +notes: + - This module requires the netconf system service be enabled on the remote device being managed. + - Recommended connection is C(netconf). + - This module also works with C(local) connections for legacy playbooks. options: interface: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_vxlan_arp.py b/lib/ansible/modules/network/cloudengine/ce_vxlan_arp.py index 72d1d985052..f4c69087934 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vxlan_arp.py +++ b/lib/ansible/modules/network/cloudengine/ce_vxlan_arp.py @@ -28,6 +28,9 @@ short_description: Manages ARP attributes of VXLAN on HUAWEI CloudEngine devices description: - Manages ARP attributes of VXLAN on HUAWEI CloudEngine devices. author: QijunPan (@QijunPan) +notes: + - Recommended connection is C(network_cli). + - This module also works with C(local) connections for legacy playbooks. options: evn_bgp: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_vxlan_gateway.py b/lib/ansible/modules/network/cloudengine/ce_vxlan_gateway.py index 22c9127ed0f..a145d0aa575 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vxlan_gateway.py +++ b/lib/ansible/modules/network/cloudengine/ce_vxlan_gateway.py @@ -31,6 +31,8 @@ description: author: QijunPan (@QijunPan) notes: - Ensure All-Active Gateways or Distributed Gateway for the VXLAN Network can not configure at the same time. + - Recommended connection is C(network_cli). + - This module also works with C(local) connections for legacy playbooks. options: dfs_id: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_vxlan_global.py b/lib/ansible/modules/network/cloudengine/ce_vxlan_global.py index 7c800612c5c..d3b9ff1a6e7 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vxlan_global.py +++ b/lib/ansible/modules/network/cloudengine/ce_vxlan_global.py @@ -28,6 +28,9 @@ short_description: Manages global attributes of VXLAN and bridge domain on HUAWE description: - Manages global attributes of VXLAN and bridge domain on HUAWEI CloudEngine devices. author: QijunPan (@QijunPan) +notes: + - Recommended connection is C(network_cli). + - This module also works with C(local) connections for legacy playbooks. options: bridge_domain_id: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_vxlan_tunnel.py b/lib/ansible/modules/network/cloudengine/ce_vxlan_tunnel.py index eeed87acde0..ff792185387 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vxlan_tunnel.py +++ b/lib/ansible/modules/network/cloudengine/ce_vxlan_tunnel.py @@ -30,6 +30,10 @@ description: and configure an ingress replication list on HUAWEI CloudEngine devices. author: - Li Yanfeng (@QijunPan) +notes: + - This module requires the netconf system service be enabled on the remote device being managed. + - Recommended connection is C(netconf). + - This module also works with C(local) connections for legacy playbooks. options: bridge_domain_id: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_vxlan_vap.py b/lib/ansible/modules/network/cloudengine/ce_vxlan_vap.py index 711202f98bc..cf9c4c032a9 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vxlan_vap.py +++ b/lib/ansible/modules/network/cloudengine/ce_vxlan_vap.py @@ -28,6 +28,10 @@ short_description: Manages VXLAN virtual access point on HUAWEI CloudEngine Devi description: - Manages VXLAN Virtual access point on HUAWEI CloudEngine Devices. author: QijunPan (@QijunPan) +notes: + - This module requires the netconf system service be enabled on the remote device being managed. + - Recommended connection is C(netconf). + - This module also works with C(local) connections for legacy playbooks. options: bridge_domain_id: description: