mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-07 13:52:54 +00:00
Add note to network agnostic modules for supported platforms (#51617)
* added doc fragment to multiple network modules
This commit is contained in:
committed by
Alicia Cozine
parent
84a6519481
commit
eb6989ecbc
@@ -19,6 +19,7 @@ author: "Nathaniel Case (@qalthos)"
|
||||
short_description: Run a cli command on cli-based network devices
|
||||
description:
|
||||
- Sends a command to a network device and returns the result read from the device.
|
||||
extends_documentation_fragment: network_agnostic
|
||||
options:
|
||||
command:
|
||||
description:
|
||||
|
||||
@@ -22,6 +22,7 @@ short_description: Push text based configuration to network devices over network
|
||||
description:
|
||||
- This module provides platform agnostic way of pushing text based
|
||||
configuration to network devices over network_cli connection plugin.
|
||||
extends_documentation_fragment: network_agnostic
|
||||
options:
|
||||
config:
|
||||
description:
|
||||
|
||||
@@ -22,6 +22,7 @@ short_description: Copy a file from a network device to Ansible Controller
|
||||
description:
|
||||
- This module provides functionality to copy file from network device to
|
||||
ansible controller.
|
||||
extends_documentation_fragment: network_agnostic
|
||||
options:
|
||||
src:
|
||||
description:
|
||||
|
||||
@@ -22,6 +22,7 @@ short_description: Copy a file from Ansible Controller to a network device
|
||||
description:
|
||||
- This module provides functionality to copy file from Ansible controller to
|
||||
network devices.
|
||||
extends_documentation_fragment: network_agnostic
|
||||
options:
|
||||
src:
|
||||
description:
|
||||
|
||||
@@ -22,6 +22,7 @@ short_description: Manage Interface on network devices
|
||||
description:
|
||||
- This module provides declarative management of Interfaces
|
||||
on network devices.
|
||||
extends_documentation_fragment: network_agnostic
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
|
||||
@@ -22,6 +22,7 @@ short_description: Manage link aggregation groups on network devices
|
||||
description:
|
||||
- This module provides declarative management of link aggregation groups
|
||||
on network devices.
|
||||
extends_documentation_fragment: network_agnostic
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
|
||||
@@ -21,6 +21,7 @@ short_description: Manage LLDP interfaces configuration on network devices
|
||||
description:
|
||||
- This module provides declarative management of LLDP interfaces
|
||||
configuration on network devices.
|
||||
extends_documentation_fragment: network_agnostic
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
|
||||
@@ -21,6 +21,7 @@ short_description: Manage Layer-2 interface on network devices
|
||||
description:
|
||||
- This module provides declarative management of Layer-2 interface
|
||||
on network devices.
|
||||
extends_documentation_fragment: network_agnostic
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
|
||||
@@ -22,6 +22,7 @@ short_description: Manage VLANs on network devices
|
||||
description:
|
||||
- This module provides declarative management of VLANs
|
||||
on network devices.
|
||||
extends_documentation_fragment: network_agnostic
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
|
||||
@@ -22,6 +22,7 @@ short_description: Manage L3 interfaces on network devices
|
||||
description:
|
||||
- This module provides declarative management of L3 interfaces
|
||||
on network devices.
|
||||
extends_documentation_fragment: network_agnostic
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
|
||||
@@ -22,6 +22,7 @@ short_description: Manage VRFs on network devices
|
||||
description:
|
||||
- This module provides declarative management of VRFs
|
||||
on network devices.
|
||||
extends_documentation_fragment: network_agnostic
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
|
||||
@@ -23,7 +23,9 @@ description:
|
||||
the IETF. It is documented in RFC 6241.
|
||||
- This module allows the user to send a configuration XML file to a netconf
|
||||
device, and detects if there was a configuration change.
|
||||
extends_documentation_fragment: netconf
|
||||
extends_documentation_fragment:
|
||||
- netconf
|
||||
- network_agnostic
|
||||
options:
|
||||
content:
|
||||
description:
|
||||
|
||||
@@ -26,6 +26,7 @@ description:
|
||||
the IETF. It is documented in RFC 6241.
|
||||
- This module allows the user to fetch configuration and state data from NETCONF
|
||||
enabled network devices.
|
||||
extends_documentation_fragment: network_agnostic
|
||||
options:
|
||||
source:
|
||||
description:
|
||||
|
||||
@@ -26,6 +26,7 @@ description:
|
||||
the IETF. It is documented in RFC 6241.
|
||||
- This module allows the user to execute NETCONF RPC requests as defined
|
||||
by IETF RFC standards as well as proprietary requests.
|
||||
extends_documentation_fragment: network_agnostic
|
||||
options:
|
||||
rpc:
|
||||
description:
|
||||
|
||||
@@ -22,6 +22,7 @@ short_description: Manage LLDP service configuration on network devices
|
||||
description:
|
||||
- This module provides declarative management of LLDP service configuration
|
||||
on network devices.
|
||||
extends_documentation_fragment: network_agnostic
|
||||
options:
|
||||
state:
|
||||
description:
|
||||
|
||||
@@ -21,6 +21,7 @@ description:
|
||||
- This will configure both login and motd banners on network devices.
|
||||
It allows playbooks to add or remove
|
||||
banner text from the active running configuration.
|
||||
extends_documentation_fragment: network_agnostic
|
||||
options:
|
||||
banner:
|
||||
description:
|
||||
|
||||
@@ -22,6 +22,7 @@ short_description: Manage logging on network devices
|
||||
description:
|
||||
- This module provides declarative management of logging
|
||||
on network devices.
|
||||
extends_documentation_fragment: network_agnostic
|
||||
options:
|
||||
dest:
|
||||
description:
|
||||
|
||||
@@ -23,6 +23,7 @@ description:
|
||||
- Tests reachability using ping from network device to a remote destination.
|
||||
- For Windows targets, use the M(win_ping) module instead.
|
||||
- For targets running Python, use the M(ping) module instead.
|
||||
extends_documentation_fragment: network_agnostic
|
||||
options:
|
||||
count:
|
||||
description:
|
||||
|
||||
@@ -24,6 +24,7 @@ description:
|
||||
on network devices. It provides an option to configure host system
|
||||
parameters or remove those parameters from the device active
|
||||
configuration.
|
||||
extends_documentation_fragment: network_agnostic
|
||||
options:
|
||||
hostname:
|
||||
description:
|
||||
|
||||
@@ -24,6 +24,7 @@ description:
|
||||
either individual usernames or the aggregate of usernames in the
|
||||
current running config. It also supports purging usernames from the
|
||||
configuration that are not explicitly defined.
|
||||
extends_documentation_fragment: network_agnostic
|
||||
options:
|
||||
aggregate:
|
||||
description:
|
||||
|
||||
Reference in New Issue
Block a user