From 23812f4b6eb3dd4366c9d91f6b4e9efa84a149b5 Mon Sep 17 00:00:00 2001 From: Xu Yuandong Date: Wed, 20 Nov 2019 01:33:08 +0800 Subject: [PATCH] Backport/2.8/64927 Doc notes 4 (#64927) (#64940) * Doc notes 4 (#64927) * exclude new in 2.10 (cherry picked from commit 2ccdf29b5bd4a2ae536dce02c4e14da715307f4a) * add a changelog, update 64940_update_modules_docs_notes.yml --- changelogs/fragments/64940_update_modules_docs_notes.yml | 4 ++++ lib/ansible/modules/network/cloudengine/ce_link_status.py | 3 +++ lib/ansible/modules/network/cloudengine/ce_mlag_config.py | 4 ++++ lib/ansible/modules/network/cloudengine/ce_mlag_interface.py | 4 ++++ lib/ansible/modules/network/cloudengine/ce_mtu.py | 2 ++ lib/ansible/modules/network/cloudengine/ce_netconf.py | 4 ++++ lib/ansible/modules/network/cloudengine/ce_netstream_aging.py | 3 +++ .../modules/network/cloudengine/ce_netstream_export.py | 2 ++ 8 files changed, 26 insertions(+) create mode 100644 changelogs/fragments/64940_update_modules_docs_notes.yml diff --git a/changelogs/fragments/64940_update_modules_docs_notes.yml b/changelogs/fragments/64940_update_modules_docs_notes.yml new file mode 100644 index 00000000000..8f0086af54c --- /dev/null +++ b/changelogs/fragments/64940_update_modules_docs_notes.yml @@ -0,0 +1,4 @@ +--- +bugfixes: + - ce modules - Update(add) docs notes to tell user modules work connection. + diff --git a/lib/ansible/modules/network/cloudengine/ce_link_status.py b/lib/ansible/modules/network/cloudengine/ce_link_status.py index 93ea0528e7c..f617f8cbf05 100644 --- a/lib/ansible/modules/network/cloudengine/ce_link_status.py +++ b/lib/ansible/modules/network/cloudengine/ce_link_status.py @@ -52,6 +52,9 @@ notes: - Outbound rate(byte/sec) shows the rate at which an interface sends bytes within an interval. - Outbound rate(pkts/sec) shows the rate at which an interface sends packets within an interval. - Speed shows the rate for an Ethernet interface. + - 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_mlag_config.py b/lib/ansible/modules/network/cloudengine/ce_mlag_config.py index 6d4d2a8d200..6a95a7a7a7a 100644 --- a/lib/ansible/modules/network/cloudengine/ce_mlag_config.py +++ b/lib/ansible/modules/network/cloudengine/ce_mlag_config.py @@ -29,6 +29,10 @@ description: - Manages MLAG configuration 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: dfs_group_id: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_mlag_interface.py b/lib/ansible/modules/network/cloudengine/ce_mlag_interface.py index 5c791ab6693..189d97786b8 100644 --- a/lib/ansible/modules/network/cloudengine/ce_mlag_interface.py +++ b/lib/ansible/modules/network/cloudengine/ce_mlag_interface.py @@ -29,6 +29,10 @@ description: - Manages MLAG interface attributes 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: eth_trunk_id: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_mtu.py b/lib/ansible/modules/network/cloudengine/ce_mtu.py index 7d037cf7e70..b5204e998b1 100644 --- a/lib/ansible/modules/network/cloudengine/ce_mtu.py +++ b/lib/ansible/modules/network/cloudengine/ce_mtu.py @@ -31,6 +31,8 @@ author: QijunPan (@QijunPan) notes: - Either C(sysmtu) param is required or C(interface) AND C(mtu) params are req'd. - C(state=absent) unconfigures a given MTU if that value is currently present. + - Recommended connection is C(network_cli). + - This module also works with C(local) connections for legacy playbooks. options: interface: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_netconf.py b/lib/ansible/modules/network/cloudengine/ce_netconf.py index a72bdaf69e1..1d741b77b21 100644 --- a/lib/ansible/modules/network/cloudengine/ce_netconf.py +++ b/lib/ansible/modules/network/cloudengine/ce_netconf.py @@ -29,6 +29,10 @@ description: - Sends an arbitrary netconf command 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: rpc: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_netstream_aging.py b/lib/ansible/modules/network/cloudengine/ce_netstream_aging.py index 7dbf63bef02..14267ce5951 100644 --- a/lib/ansible/modules/network/cloudengine/ce_netstream_aging.py +++ b/lib/ansible/modules/network/cloudengine/ce_netstream_aging.py @@ -27,6 +27,9 @@ short_description: Manages timeout mode of NetStream on HUAWEI CloudEngine switc description: - Manages timeout mode 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: timeout_interval: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_netstream_export.py b/lib/ansible/modules/network/cloudengine/ce_netstream_export.py index a4232c9d6bd..aefd8eb2b7c 100644 --- a/lib/ansible/modules/network/cloudengine/ce_netstream_export.py +++ b/lib/ansible/modules/network/cloudengine/ce_netstream_export.py @@ -29,6 +29,8 @@ description: - Configure NetStream flow statistics exporting and versions for exported packets on HUAWEI CloudEngine switches. author: Zhijin Zhou (@QijunPan) notes: + - Recommended connection is C(network_cli). + - This module also works with C(local) connections for legacy playbooks. options: type: description: