From 705c014ec3b99a7e3ad4c0e1ec4744c43415df8f Mon Sep 17 00:00:00 2001 From: Xu Yuandong Date: Mon, 4 Nov 2019 10:25:24 +0800 Subject: [PATCH] Doc notes 1 (#64346) * addd * all update * add notes to set modules works with C(connection) --- lib/ansible/modules/network/cloudengine/ce_aaa_server.py | 4 ++++ lib/ansible/modules/network/cloudengine/ce_aaa_server_host.py | 4 ++++ lib/ansible/modules/network/cloudengine/ce_acl.py | 4 ++++ lib/ansible/modules/network/cloudengine/ce_acl_advance.py | 4 ++++ lib/ansible/modules/network/cloudengine/ce_acl_interface.py | 3 +++ lib/ansible/modules/network/cloudengine/ce_bfd_global.py | 4 ++++ lib/ansible/modules/network/cloudengine/ce_bfd_session.py | 4 ++++ lib/ansible/modules/network/cloudengine/ce_bfd_view.py | 4 ++++ lib/ansible/modules/network/cloudengine/ce_bgp.py | 4 ++++ lib/ansible/modules/network/cloudengine/ce_bgp_af.py | 4 ++++ 10 files changed, 39 insertions(+) diff --git a/lib/ansible/modules/network/cloudengine/ce_aaa_server.py b/lib/ansible/modules/network/cloudengine/ce_aaa_server.py index 6e80ef86b9..fb726a2fee 100644 --- a/lib/ansible/modules/network/cloudengine/ce_aaa_server.py +++ b/lib/ansible/modules/network/cloudengine/ce_aaa_server.py @@ -29,6 +29,10 @@ description: - Manages AAA server global 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: state: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_aaa_server_host.py b/lib/ansible/modules/network/cloudengine/ce_aaa_server_host.py index f453ae3eda..f52f67d65d 100644 --- a/lib/ansible/modules/network/cloudengine/ce_aaa_server_host.py +++ b/lib/ansible/modules/network/cloudengine/ce_aaa_server_host.py @@ -29,6 +29,10 @@ description: - Manages AAA server host 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: state: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_acl.py b/lib/ansible/modules/network/cloudengine/ce_acl.py index 4885c34320..901563047f 100644 --- a/lib/ansible/modules/network/cloudengine/ce_acl.py +++ b/lib/ansible/modules/network/cloudengine/ce_acl.py @@ -29,6 +29,10 @@ description: - Manages base ACL 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_acl_advance.py b/lib/ansible/modules/network/cloudengine/ce_acl_advance.py index ec992d23bd..f7a5ac606c 100644 --- a/lib/ansible/modules/network/cloudengine/ce_acl_advance.py +++ b/lib/ansible/modules/network/cloudengine/ce_acl_advance.py @@ -29,6 +29,10 @@ description: - Manages advanced ACL 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_acl_interface.py b/lib/ansible/modules/network/cloudengine/ce_acl_interface.py index a71d30d5f1..203b92d18e 100644 --- a/lib/ansible/modules/network/cloudengine/ce_acl_interface.py +++ b/lib/ansible/modules/network/cloudengine/ce_acl_interface.py @@ -29,6 +29,9 @@ description: - Manages applying ACLs to interfaces 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: acl_name: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_bfd_global.py b/lib/ansible/modules/network/cloudengine/ce_bfd_global.py index 77bedb5e93..1acb0b6480 100644 --- a/lib/ansible/modules/network/cloudengine/ce_bfd_global.py +++ b/lib/ansible/modules/network/cloudengine/ce_bfd_global.py @@ -28,6 +28,10 @@ short_description: Manages BFD global configuration on HUAWEI CloudEngine device description: - Manages BFD global configuration 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: bfd_enable: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_bfd_session.py b/lib/ansible/modules/network/cloudengine/ce_bfd_session.py index 76180371b5..84979a4c6b 100644 --- a/lib/ansible/modules/network/cloudengine/ce_bfd_session.py +++ b/lib/ansible/modules/network/cloudengine/ce_bfd_session.py @@ -29,6 +29,10 @@ description: - Manages BFD session configuration, creates a BFD session or deletes a specified BFD session 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: session_name: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_bfd_view.py b/lib/ansible/modules/network/cloudengine/ce_bfd_view.py index d87317e0b0..7932d17d82 100644 --- a/lib/ansible/modules/network/cloudengine/ce_bfd_view.py +++ b/lib/ansible/modules/network/cloudengine/ce_bfd_view.py @@ -28,6 +28,10 @@ short_description: Manages BFD session view configuration on HUAWEI CloudEngine description: - Manages BFD session view configuration 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: session_name: description: diff --git a/lib/ansible/modules/network/cloudengine/ce_bgp.py b/lib/ansible/modules/network/cloudengine/ce_bgp.py index a3a6029881..c707bf8e66 100644 --- a/lib/ansible/modules/network/cloudengine/ce_bgp.py +++ b/lib/ansible/modules/network/cloudengine/ce_bgp.py @@ -29,6 +29,10 @@ description: - Manages BGP 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_bgp_af.py b/lib/ansible/modules/network/cloudengine/ce_bgp_af.py index 80d3584e55..59b80c39da 100644 --- a/lib/ansible/modules/network/cloudengine/ce_bgp_af.py +++ b/lib/ansible/modules/network/cloudengine/ce_bgp_af.py @@ -29,6 +29,10 @@ description: - Manages BGP Address-family 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: