Doc notes 2 (#64347)

* addd

* all  update

* add/fix notes about modules work with connection

* duplication of key "notes"

* Update ce_evpn_bgp_rr.py

* Update ce_evpn_bgp.py
This commit is contained in:
Xu Yuandong 2019-11-04 10:56:57 +08:00 committed by ansibot
parent 1d40d429a0
commit 9e3b1f3b32
10 changed files with 31 additions and 0 deletions

View file

@ -29,6 +29,10 @@ description:
- Manages BGP peer configurations on HUAWEI CloudEngine switches. - Manages BGP peer configurations on HUAWEI CloudEngine switches.
author: author:
- wangdezhuang (@QijunPan) - 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: options:
state: state:
description: description:

View file

@ -29,6 +29,10 @@ description:
- Manages BGP neighbor Address-family configurations on HUAWEI CloudEngine switches. - Manages BGP neighbor Address-family configurations on HUAWEI CloudEngine switches.
author: author:
- wangdezhuang (@QijunPan) - 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: options:
vrf_name: vrf_name:
description: description:

View file

@ -34,6 +34,9 @@ description:
the results read from the device. The ce_command module includes an the results read from the device. The ce_command module includes an
argument that will cause the module to wait for a specific condition argument that will cause the module to wait for a specific condition
before returning or timing out if the condition is not met. before returning or timing out if the condition is not met.
notes:
- Recommended connection is C(network_cli).
- This module also works with C(local) connections for legacy playbooks.
options: options:
commands: commands:
description: description:

View file

@ -31,6 +31,9 @@ description:
for segmenting configuration into sections. This module provides for segmenting configuration into sections. This module provides
an implementation for working with CloudEngine configuration sections in an implementation for working with CloudEngine configuration sections in
a deterministic way. This module works with CLI transports. a deterministic way. This module works with CLI transports.
notes:
- Recommended connection is C(network_cli).
- This module also works with C(local) connections for legacy playbooks.
options: options:
lines: lines:
description: description:

View file

@ -38,6 +38,9 @@ notes:
DLDP working mode. DLDP working mode.
- The default interval for sending Advertisement packets is 5 seconds, so you are advised to use time_interval=5 to - The default interval for sending Advertisement packets is 5 seconds, so you are advised to use time_interval=5 to
restore default DLDP interval. restore default DLDP interval.
- 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: options:
enable: enable:
description: description:

View file

@ -34,6 +34,9 @@ notes:
- If C(state=present, enable=disable), interface DLDP enable will be turned off and - If C(state=present, enable=disable), interface DLDP enable will be turned off and
related interface DLDP configuration will be cleared. related interface DLDP configuration will be cleared.
- If C(state=absent), only local_mac is supported to configure. - If C(state=absent), only local_mac is supported to configure.
- 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: options:
interface: interface:
description: description:

View file

@ -34,6 +34,9 @@ notes:
passed, all existing members (if any), are removed, passed, all existing members (if any), are removed,
and Eth-Trunk removed. and Eth-Trunk removed.
- Members must be a list. - Members must be a list.
- 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: options:
trunk_id: trunk_id:
description: description:

View file

@ -42,6 +42,9 @@ notes:
- When using state:absent, evpn is not supported and it will be ignored. - When using state:absent, evpn is not supported and it will be ignored.
- When using state:absent to delete VPN target attributes, ensure the configuration of VPN target attributes has - When using state:absent to delete VPN target attributes, ensure the configuration of VPN target attributes has
existed and otherwise it will report an error. existed and otherwise it will report an error.
- 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: options:
bridge_domain_id: bridge_domain_id:
description: description:

View file

@ -28,6 +28,9 @@ description:
- This module offers the ability to configure a BGP EVPN peer relationship on HUAWEI CloudEngine switches. - This module offers the ability to configure a BGP EVPN peer relationship on HUAWEI CloudEngine switches.
author: author:
- Li Yanfeng (@QijunPan) - Li Yanfeng (@QijunPan)
notes:
- Recommended connection is C(network_cli).
- This module also works with C(local) connections for legacy playbooks.
options: options:
bgp_instance: bgp_instance:
description: description:

View file

@ -31,6 +31,8 @@ author: Zhijin Zhou (@QijunPan)
notes: notes:
- Ensure that BGP view is existed. - Ensure that BGP view is existed.
- The peer, peer_type, and reflect_client arguments must all exist or not exist. - The peer, peer_type, and reflect_client arguments must all exist or not exist.
- Recommended connection is C(network_cli).
- This module also works with C(local) connections for legacy playbooks.
options: options:
as_number: as_number:
description: description: