Doc notes 5 (#64350)

* addd

* all  update

* add/update notes.

* add/updates notes.
This commit is contained in:
Xu Yuandong 2019-11-04 10:46:18 +08:00 committed by ansibot
parent 25e03b1e75
commit 1d40d429a0
20 changed files with 72 additions and 10 deletions

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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: