From 1d40d429a0397e2a3799932298a11c27598fc588 Mon Sep 17 00:00:00 2001
From: Xu Yuandong <yuandongdeyouxiang@gmail.com>
Date: Mon, 4 Nov 2019 10:46:18 +0800
Subject: [PATCH] Doc notes 5 (#64350)

* addd

* all  update

* add/update notes.

* add/updates notes.
---
 .../network/cloudengine/ce_netstream_global.py       |  3 +++
 .../network/cloudengine/ce_netstream_template.py     |  3 +++
 lib/ansible/modules/network/cloudengine/ce_ntp.py    |  4 ++++
 .../modules/network/cloudengine/ce_ntp_auth.py       |  2 ++
 lib/ansible/modules/network/cloudengine/ce_ospf.py   |  4 ++++
 .../modules/network/cloudengine/ce_ospf_vrf.py       |  4 ++++
 lib/ansible/modules/network/cloudengine/ce_reboot.py |  4 ++++
 .../modules/network/cloudengine/ce_rollback.py       |  3 +++
 lib/ansible/modules/network/cloudengine/ce_sflow.py  |  4 ++++
 .../modules/network/cloudengine/ce_snmp_community.py |  4 ++++
 .../modules/network/cloudengine/ce_snmp_contact.py   |  3 +++
 .../modules/network/cloudengine/ce_snmp_location.py  |  3 +++
 .../network/cloudengine/ce_snmp_target_host.py       |  4 ++++
 .../modules/network/cloudengine/ce_snmp_traps.py     |  3 +++
 .../modules/network/cloudengine/ce_snmp_user.py      |  4 ++++
 .../modules/network/cloudengine/ce_startup.py        |  3 +++
 .../modules/network/cloudengine/ce_static_route.py   |  6 ++++--
 .../network/cloudengine/ce_static_route_bfd.py       |  6 ++++--
 lib/ansible/modules/network/cloudengine/ce_stp.py    |  3 +++
 .../modules/network/cloudengine/ce_switchport.py     | 12 ++++++------
 20 files changed, 72 insertions(+), 10 deletions(-)

diff --git a/lib/ansible/modules/network/cloudengine/ce_netstream_global.py b/lib/ansible/modules/network/cloudengine/ce_netstream_global.py
index 952dd3ede4d..ec244dd95cf 100644
--- a/lib/ansible/modules/network/cloudengine/ce_netstream_global.py
+++ b/lib/ansible/modules/network/cloudengine/ce_netstream_global.py
@@ -27,6 +27,9 @@ short_description: Manages global parameters of NetStream on HUAWEI CloudEngine
 description:
     - Manages global parameters of NetStream on HUAWEI CloudEngine switches.
 author: YangYang (@QijunPan)
+notes:
+    - Recommended connection is C(network_cli).
+    - This module also works with C(local) connections for legacy playbooks.
 options:
     type:
         description:
diff --git a/lib/ansible/modules/network/cloudengine/ce_netstream_template.py b/lib/ansible/modules/network/cloudengine/ce_netstream_template.py
index 75b5659f879..df07fcc77a4 100644
--- a/lib/ansible/modules/network/cloudengine/ce_netstream_template.py
+++ b/lib/ansible/modules/network/cloudengine/ce_netstream_template.py
@@ -29,6 +29,9 @@ description:
     - Manages NetStream template configuration on HUAWEI CloudEngine switches.
 author:
     - wangdezhuang (@QijunPan)
+notes:
+    - Recommended connection is C(network_cli).
+    - This module also works with C(local) connections for legacy playbooks.
 options:
     state:
         description:
diff --git a/lib/ansible/modules/network/cloudengine/ce_ntp.py b/lib/ansible/modules/network/cloudengine/ce_ntp.py
index 17a263972aa..238693dd11f 100644
--- a/lib/ansible/modules/network/cloudengine/ce_ntp.py
+++ b/lib/ansible/modules/network/cloudengine/ce_ntp.py
@@ -29,6 +29,10 @@ description:
     - Manages core NTP configuration on HUAWEI CloudEngine switches.
 author:
     - Zhijin Zhou (@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:
     server:
         description:
diff --git a/lib/ansible/modules/network/cloudengine/ce_ntp_auth.py b/lib/ansible/modules/network/cloudengine/ce_ntp_auth.py
index a094b82fcb8..8e80fa67ea4 100644
--- a/lib/ansible/modules/network/cloudengine/ce_ntp_auth.py
+++ b/lib/ansible/modules/network/cloudengine/ce_ntp_auth.py
@@ -35,6 +35,8 @@ notes:
       If a matching key configuration isn't found on the device, the module will fail.
     - If C(state=absent) and C(authentication=on), authentication will be turned on.
     - If C(state=absent) and C(authentication=off), authentication will be turned off.
+    - Recommended connection is C(network_cli).
+    - This module also works with C(local) connections for legacy playbooks.
 options:
     key_id:
         description:
diff --git a/lib/ansible/modules/network/cloudengine/ce_ospf.py b/lib/ansible/modules/network/cloudengine/ce_ospf.py
index cb1b7fdc59c..fbeb6b225c1 100644
--- a/lib/ansible/modules/network/cloudengine/ce_ospf.py
+++ b/lib/ansible/modules/network/cloudengine/ce_ospf.py
@@ -28,6 +28,10 @@ short_description: Manages configuration of an OSPF instance on HUAWEI CloudEngi
 description:
     - Manages configuration of an OSPF instance 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:
     process_id:
         description:
diff --git a/lib/ansible/modules/network/cloudengine/ce_ospf_vrf.py b/lib/ansible/modules/network/cloudengine/ce_ospf_vrf.py
index 6eed6dcd02a..39f04fa2f76 100644
--- a/lib/ansible/modules/network/cloudengine/ce_ospf_vrf.py
+++ b/lib/ansible/modules/network/cloudengine/ce_ospf_vrf.py
@@ -28,6 +28,10 @@ short_description: Manages configuration of an OSPF VPN instance on HUAWEI Cloud
 description:
     - Manages configuration of an OSPF VPN instance on HUAWEI CloudEngine switches.
 author: Yang yang (@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:
     ospf:
         description:
diff --git a/lib/ansible/modules/network/cloudengine/ce_reboot.py b/lib/ansible/modules/network/cloudengine/ce_reboot.py
index 040f103b4be..988971023b4 100644
--- a/lib/ansible/modules/network/cloudengine/ce_reboot.py
+++ b/lib/ansible/modules/network/cloudengine/ce_reboot.py
@@ -28,6 +28,10 @@ short_description: Reboot a HUAWEI CloudEngine switches.
 description:
     - Reboot a HUAWEI CloudEngine switches.
 author: Gong Jianjun (@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.
 requirements: ["ncclient"]
 options:
     confirm:
diff --git a/lib/ansible/modules/network/cloudengine/ce_rollback.py b/lib/ansible/modules/network/cloudengine/ce_rollback.py
index f59b388764f..ac687a77488 100644
--- a/lib/ansible/modules/network/cloudengine/ce_rollback.py
+++ b/lib/ansible/modules/network/cloudengine/ce_rollback.py
@@ -29,6 +29,9 @@ description:
       file or rollback to a configuration checkpoint file on HUAWEI CloudEngine switches.
 author:
     - Li Yanfeng (@QijunPan)
+notes:
+    - Recommended connection is C(network_cli).
+    - This module also works with C(local) connections for legacy playbooks.
 options:
     commit_id:
         description:
diff --git a/lib/ansible/modules/network/cloudengine/ce_sflow.py b/lib/ansible/modules/network/cloudengine/ce_sflow.py
index 179beb08b09..590f3721414 100644
--- a/lib/ansible/modules/network/cloudengine/ce_sflow.py
+++ b/lib/ansible/modules/network/cloudengine/ce_sflow.py
@@ -30,6 +30,10 @@ description:
       detect abnormal traffic, and locate the source of attack traffic,
       ensuring stable running of the network.
 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:
     agent_ip:
         description:
diff --git a/lib/ansible/modules/network/cloudengine/ce_snmp_community.py b/lib/ansible/modules/network/cloudengine/ce_snmp_community.py
index 510d3a01e8f..d256d3bc967 100644
--- a/lib/ansible/modules/network/cloudengine/ce_snmp_community.py
+++ b/lib/ansible/modules/network/cloudengine/ce_snmp_community.py
@@ -29,6 +29,10 @@ description:
     - Manages SNMP community configuration on HUAWEI CloudEngine switches.
 author:
     - wangdezhuang (@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:
     acl_number:
         description:
diff --git a/lib/ansible/modules/network/cloudengine/ce_snmp_contact.py b/lib/ansible/modules/network/cloudengine/ce_snmp_contact.py
index 13b5a7ea58e..2a45ab05c14 100644
--- a/lib/ansible/modules/network/cloudengine/ce_snmp_contact.py
+++ b/lib/ansible/modules/network/cloudengine/ce_snmp_contact.py
@@ -29,6 +29,9 @@ description:
     - Manages SNMP contact configurations on HUAWEI CloudEngine switches.
 author:
     - wangdezhuang (@QijunPan)
+notes:
+    - Recommended connection is C(network_cli).
+    - This module also works with C(local) connections for legacy playbooks.
 options:
     contact:
         description:
diff --git a/lib/ansible/modules/network/cloudengine/ce_snmp_location.py b/lib/ansible/modules/network/cloudengine/ce_snmp_location.py
index 662a43bb00f..b0db98d2c64 100644
--- a/lib/ansible/modules/network/cloudengine/ce_snmp_location.py
+++ b/lib/ansible/modules/network/cloudengine/ce_snmp_location.py
@@ -29,6 +29,9 @@ description:
     - Manages SNMP location configurations on HUAWEI CloudEngine switches.
 author:
     - wangdezhuang (@QijunPan)
+notes:
+    - Recommended connection is C(network_cli).
+    - This module also works with C(local) connections for legacy playbooks.
 options:
     location:
         description:
diff --git a/lib/ansible/modules/network/cloudengine/ce_snmp_target_host.py b/lib/ansible/modules/network/cloudengine/ce_snmp_target_host.py
index 50604b5846e..4b7be810197 100644
--- a/lib/ansible/modules/network/cloudengine/ce_snmp_target_host.py
+++ b/lib/ansible/modules/network/cloudengine/ce_snmp_target_host.py
@@ -29,6 +29,10 @@ description:
     - Manages SNMP target host configurations on HUAWEI CloudEngine switches.
 author:
     - wangdezhuang (@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:
     version:
         description:
diff --git a/lib/ansible/modules/network/cloudengine/ce_snmp_traps.py b/lib/ansible/modules/network/cloudengine/ce_snmp_traps.py
index 06f0026b857..cfcd22e380b 100644
--- a/lib/ansible/modules/network/cloudengine/ce_snmp_traps.py
+++ b/lib/ansible/modules/network/cloudengine/ce_snmp_traps.py
@@ -29,6 +29,9 @@ description:
     - Manages SNMP traps configurations on HUAWEI CloudEngine switches.
 author:
     - wangdezhuang (@QijunPan)
+notes:
+    - Recommended connection is C(network_cli).
+    - This module also works with C(local) connections for legacy playbooks.
 options:
     feature_name:
         description:
diff --git a/lib/ansible/modules/network/cloudengine/ce_snmp_user.py b/lib/ansible/modules/network/cloudengine/ce_snmp_user.py
index 30b6478997b..1a091998065 100644
--- a/lib/ansible/modules/network/cloudengine/ce_snmp_user.py
+++ b/lib/ansible/modules/network/cloudengine/ce_snmp_user.py
@@ -29,6 +29,10 @@ description:
     - Manages SNMP user configurations on CloudEngine switches.
 author:
     - wangdezhuang (@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:
     acl_number:
         description:
diff --git a/lib/ansible/modules/network/cloudengine/ce_startup.py b/lib/ansible/modules/network/cloudengine/ce_startup.py
index c31e8560196..35b99cd6e26 100644
--- a/lib/ansible/modules/network/cloudengine/ce_startup.py
+++ b/lib/ansible/modules/network/cloudengine/ce_startup.py
@@ -29,6 +29,9 @@ description:
     - Manages a system startup information on HUAWEI CloudEngine switches.
 author:
     - Li Yanfeng (@QijunPan)
+notes:
+    - Recommended connection is C(network_cli).
+    - This module also works with C(local) connections for legacy playbooks.
 options:
     cfg_file:
         description:
diff --git a/lib/ansible/modules/network/cloudengine/ce_static_route.py b/lib/ansible/modules/network/cloudengine/ce_static_route.py
index 079a4069a17..95a0e0b9a56 100644
--- a/lib/ansible/modules/network/cloudengine/ce_static_route.py
+++ b/lib/ansible/modules/network/cloudengine/ce_static_route.py
@@ -16,8 +16,10 @@ description:
 author: Yang yang (@QijunPan)
 notes:
     - If no vrf is supplied, vrf is set to default.
-      If I(state=absent), the route will be removed, regardless of the
-      non-required parameters.
+    - If I(state=absent), the route 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:
     prefix:
         description:
diff --git a/lib/ansible/modules/network/cloudengine/ce_static_route_bfd.py b/lib/ansible/modules/network/cloudengine/ce_static_route_bfd.py
index eed59e8ca25..c02440277e8 100644
--- a/lib/ansible/modules/network/cloudengine/ce_static_route_bfd.py
+++ b/lib/ansible/modules/network/cloudengine/ce_static_route_bfd.py
@@ -32,8 +32,10 @@ description:
 author: xuxiaowei0512 (@CloudEngine-Ansible)
 notes:
   - If no vrf is supplied, vrf is set to default.
-    If I(state=absent), the route configuration will be removed, regardless of the
-    non-required parameters.
+  - If I(state=absent), the route configuration 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:
   prefix:
     description:
diff --git a/lib/ansible/modules/network/cloudengine/ce_stp.py b/lib/ansible/modules/network/cloudengine/ce_stp.py
index 046af50d55f..0b81e3a11e6 100644
--- a/lib/ansible/modules/network/cloudengine/ce_stp.py
+++ b/lib/ansible/modules/network/cloudengine/ce_stp.py
@@ -29,6 +29,9 @@ description:
     - Manages STP configurations on HUAWEI CloudEngine switches.
 author:
     - wangdezhuang (@QijunPan)
+notes:
+    - Recommended connection is C(network_cli).
+    - This module also works with C(local) connections for legacy playbooks.
 options:
     state:
         description:
diff --git a/lib/ansible/modules/network/cloudengine/ce_switchport.py b/lib/ansible/modules/network/cloudengine/ce_switchport.py
index 9ab50a8f89f..6ea4c65893c 100644
--- a/lib/ansible/modules/network/cloudengine/ce_switchport.py
+++ b/lib/ansible/modules/network/cloudengine/ce_switchport.py
@@ -30,13 +30,13 @@ description:
 author: QijunPan (@QijunPan)
 notes:
     - When C(state=absent), VLANs can be added/removed from trunk links and
-      the existing access VLAN can be 'unconfigured' to just having VLAN 1
-      on that interface.
+      the existing access VLAN can be 'unconfigured' to just having VLAN 1 on that interface.
     - When working with trunks VLANs the keywords add/remove are always sent
-      in the C(port trunk allow-pass vlan) command. Use verbose mode to see
-      commands sent.
-    - When C(state=unconfigured), the interface will result with having a default
-      Layer 2 interface, i.e. vlan 1 in access mode.
+      in the C(port trunk allow-pass vlan) command. Use verbose mode to see commands sent.
+    - When C(state=unconfigured), the interface will result with having a default Layer 2 interface, i.e. vlan 1 in access mode.
+    - 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: