diff --git a/changelogs/fragments/64947_update_modules_docs_notes.yml b/changelogs/fragments/64947_update_modules_docs_notes.yml new file mode 100644 index 00000000000..552ec45d0e1 --- /dev/null +++ b/changelogs/fragments/64947_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_evpn_global.py b/lib/ansible/modules/network/cloudengine/ce_evpn_global.py index bdc9d296264..2ec11b76a82 100644 --- a/lib/ansible/modules/network/cloudengine/ce_evpn_global.py +++ b/lib/ansible/modules/network/cloudengine/ce_evpn_global.py @@ -30,6 +30,8 @@ description: author: Zhijin Zhou (@QijunPan) notes: - Before configuring evpn_overlay_enable=disable, delete other EVPN configurations. + - Recommended connection is C(network_cli). + - This module also works with C(local) connections for legacy playbooks. options: evpn_overlay_enable: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_facts.py b/lib/ansible/modules/network/cloudengine/ce_facts.py index 5abe585b0f8..9e9d849cf74 100644 --- a/lib/ansible/modules/network/cloudengine/ce_facts.py +++ b/lib/ansible/modules/network/cloudengine/ce_facts.py @@ -33,7 +33,9 @@ description: with C(ansible_net_). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts. - +notes: + - Recommended connection is C(network_cli). + - This module also works with C(local) connections for legacy playbooks. options: gather_subset: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_file_copy.py b/lib/ansible/modules/network/cloudengine/ce_file_copy.py index 45abdd966ab..284d15817ff 100644 --- a/lib/ansible/modules/network/cloudengine/ce_file_copy.py +++ b/lib/ansible/modules/network/cloudengine/ce_file_copy.py @@ -19,6 +19,9 @@ author: notes: - The feature must be enabled with feature scp-server. - If the file is already present, no transfer will take place. + - 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: - paramiko options: diff --git a/lib/ansible/modules/network/cloudengine/ce_info_center_debug.py b/lib/ansible/modules/network/cloudengine/ce_info_center_debug.py index 74f69f3a6d4..ef21a66ab2d 100644 --- a/lib/ansible/modules/network/cloudengine/ce_info_center_debug.py +++ b/lib/ansible/modules/network/cloudengine/ce_info_center_debug.py @@ -29,6 +29,10 @@ description: - Manages information center debug 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: state: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_info_center_global.py b/lib/ansible/modules/network/cloudengine/ce_info_center_global.py index e2a00063e57..c2cb7ca19b5 100644 --- a/lib/ansible/modules/network/cloudengine/ce_info_center_global.py +++ b/lib/ansible/modules/network/cloudengine/ce_info_center_global.py @@ -29,6 +29,10 @@ description: - This module offers the ability to be output to the log buffer, log file, console, terminal, or log host on HUAWEI CloudEngine switches. 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: info_center_enable: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_info_center_log.py b/lib/ansible/modules/network/cloudengine/ce_info_center_log.py index 4ed63ace815..7f50d8ec850 100644 --- a/lib/ansible/modules/network/cloudengine/ce_info_center_log.py +++ b/lib/ansible/modules/network/cloudengine/ce_info_center_log.py @@ -29,6 +29,10 @@ description: - Setting the Timestamp Format of Logs. Configuring the Device to Output Logs to the Log Buffer. 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: log_time_stamp: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_info_center_trap.py b/lib/ansible/modules/network/cloudengine/ce_info_center_trap.py index 49387901761..ff66d1361a0 100644 --- a/lib/ansible/modules/network/cloudengine/ce_info_center_trap.py +++ b/lib/ansible/modules/network/cloudengine/ce_info_center_trap.py @@ -29,6 +29,10 @@ description: - Manages information center trap 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: state: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_interface.py b/lib/ansible/modules/network/cloudengine/ce_interface.py index 47ead521c43..7b126e814f4 100644 --- a/lib/ansible/modules/network/cloudengine/ce_interface.py +++ b/lib/ansible/modules/network/cloudengine/ce_interface.py @@ -31,6 +31,9 @@ author: QijunPan (@QijunPan) notes: - This module is also used to create logical interfaces such as vlanif and loopbacks. + - 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_interface_ospf.py b/lib/ansible/modules/network/cloudengine/ce_interface_ospf.py index 02901b7b079..b011ac3658d 100644 --- a/lib/ansible/modules/network/cloudengine/ce_interface_ospf.py +++ b/lib/ansible/modules/network/cloudengine/ce_interface_ospf.py @@ -28,6 +28,10 @@ short_description: Manages configuration of an OSPF interface instanceon HUAWEI description: - Manages configuration of an OSPF interface instanceon 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: interface: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_ip_interface.py b/lib/ansible/modules/network/cloudengine/ce_ip_interface.py index ccf7d493060..e6ed37dbe75 100644 --- a/lib/ansible/modules/network/cloudengine/ce_ip_interface.py +++ b/lib/ansible/modules/network/cloudengine/ce_ip_interface.py @@ -34,6 +34,9 @@ notes: - C(mask) must be inserted in decimal format (i.e. 24) for both IPv6 and IPv4. - A single interface can have multiple IPv6 configured. + - 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: