Add note to network agnostic modules for supported platforms (#51617)

* added doc fragment to multiple network modules
This commit is contained in:
Sandra McCann 2019-02-05 16:18:54 -05:00 committed by Alicia Cozine
parent 84a6519481
commit eb6989ecbc
21 changed files with 49 additions and 1 deletions

View file

@ -19,6 +19,7 @@ author: "Nathaniel Case (@qalthos)"
short_description: Run a cli command on cli-based network devices short_description: Run a cli command on cli-based network devices
description: description:
- Sends a command to a network device and returns the result read from the device. - Sends a command to a network device and returns the result read from the device.
extends_documentation_fragment: network_agnostic
options: options:
command: command:
description: description:

View file

@ -22,6 +22,7 @@ short_description: Push text based configuration to network devices over network
description: description:
- This module provides platform agnostic way of pushing text based - This module provides platform agnostic way of pushing text based
configuration to network devices over network_cli connection plugin. configuration to network devices over network_cli connection plugin.
extends_documentation_fragment: network_agnostic
options: options:
config: config:
description: description:

View file

@ -22,6 +22,7 @@ short_description: Copy a file from a network device to Ansible Controller
description: description:
- This module provides functionality to copy file from network device to - This module provides functionality to copy file from network device to
ansible controller. ansible controller.
extends_documentation_fragment: network_agnostic
options: options:
src: src:
description: description:

View file

@ -22,6 +22,7 @@ short_description: Copy a file from Ansible Controller to a network device
description: description:
- This module provides functionality to copy file from Ansible controller to - This module provides functionality to copy file from Ansible controller to
network devices. network devices.
extends_documentation_fragment: network_agnostic
options: options:
src: src:
description: description:

View file

@ -22,6 +22,7 @@ short_description: Manage Interface on network devices
description: description:
- This module provides declarative management of Interfaces - This module provides declarative management of Interfaces
on network devices. on network devices.
extends_documentation_fragment: network_agnostic
options: options:
name: name:
description: description:

View file

@ -22,6 +22,7 @@ short_description: Manage link aggregation groups on network devices
description: description:
- This module provides declarative management of link aggregation groups - This module provides declarative management of link aggregation groups
on network devices. on network devices.
extends_documentation_fragment: network_agnostic
options: options:
name: name:
description: description:

View file

@ -21,6 +21,7 @@ short_description: Manage LLDP interfaces configuration on network devices
description: description:
- This module provides declarative management of LLDP interfaces - This module provides declarative management of LLDP interfaces
configuration on network devices. configuration on network devices.
extends_documentation_fragment: network_agnostic
options: options:
name: name:
description: description:

View file

@ -21,6 +21,7 @@ short_description: Manage Layer-2 interface on network devices
description: description:
- This module provides declarative management of Layer-2 interface - This module provides declarative management of Layer-2 interface
on network devices. on network devices.
extends_documentation_fragment: network_agnostic
options: options:
name: name:
description: description:

View file

@ -22,6 +22,7 @@ short_description: Manage VLANs on network devices
description: description:
- This module provides declarative management of VLANs - This module provides declarative management of VLANs
on network devices. on network devices.
extends_documentation_fragment: network_agnostic
options: options:
name: name:
description: description:

View file

@ -22,6 +22,7 @@ short_description: Manage L3 interfaces on network devices
description: description:
- This module provides declarative management of L3 interfaces - This module provides declarative management of L3 interfaces
on network devices. on network devices.
extends_documentation_fragment: network_agnostic
options: options:
name: name:
description: description:

View file

@ -22,6 +22,7 @@ short_description: Manage VRFs on network devices
description: description:
- This module provides declarative management of VRFs - This module provides declarative management of VRFs
on network devices. on network devices.
extends_documentation_fragment: network_agnostic
options: options:
name: name:
description: description:

View file

@ -23,7 +23,9 @@ description:
the IETF. It is documented in RFC 6241. the IETF. It is documented in RFC 6241.
- This module allows the user to send a configuration XML file to a netconf - This module allows the user to send a configuration XML file to a netconf
device, and detects if there was a configuration change. device, and detects if there was a configuration change.
extends_documentation_fragment: netconf extends_documentation_fragment:
- netconf
- network_agnostic
options: options:
content: content:
description: description:

View file

@ -26,6 +26,7 @@ description:
the IETF. It is documented in RFC 6241. the IETF. It is documented in RFC 6241.
- This module allows the user to fetch configuration and state data from NETCONF - This module allows the user to fetch configuration and state data from NETCONF
enabled network devices. enabled network devices.
extends_documentation_fragment: network_agnostic
options: options:
source: source:
description: description:

View file

@ -26,6 +26,7 @@ description:
the IETF. It is documented in RFC 6241. the IETF. It is documented in RFC 6241.
- This module allows the user to execute NETCONF RPC requests as defined - This module allows the user to execute NETCONF RPC requests as defined
by IETF RFC standards as well as proprietary requests. by IETF RFC standards as well as proprietary requests.
extends_documentation_fragment: network_agnostic
options: options:
rpc: rpc:
description: description:

View file

@ -22,6 +22,7 @@ short_description: Manage LLDP service configuration on network devices
description: description:
- This module provides declarative management of LLDP service configuration - This module provides declarative management of LLDP service configuration
on network devices. on network devices.
extends_documentation_fragment: network_agnostic
options: options:
state: state:
description: description:

View file

@ -21,6 +21,7 @@ description:
- This will configure both login and motd banners on network devices. - This will configure both login and motd banners on network devices.
It allows playbooks to add or remove It allows playbooks to add or remove
banner text from the active running configuration. banner text from the active running configuration.
extends_documentation_fragment: network_agnostic
options: options:
banner: banner:
description: description:

View file

@ -22,6 +22,7 @@ short_description: Manage logging on network devices
description: description:
- This module provides declarative management of logging - This module provides declarative management of logging
on network devices. on network devices.
extends_documentation_fragment: network_agnostic
options: options:
dest: dest:
description: description:

View file

@ -23,6 +23,7 @@ description:
- Tests reachability using ping from network device to a remote destination. - Tests reachability using ping from network device to a remote destination.
- For Windows targets, use the M(win_ping) module instead. - For Windows targets, use the M(win_ping) module instead.
- For targets running Python, use the M(ping) module instead. - For targets running Python, use the M(ping) module instead.
extends_documentation_fragment: network_agnostic
options: options:
count: count:
description: description:

View file

@ -24,6 +24,7 @@ description:
on network devices. It provides an option to configure host system on network devices. It provides an option to configure host system
parameters or remove those parameters from the device active parameters or remove those parameters from the device active
configuration. configuration.
extends_documentation_fragment: network_agnostic
options: options:
hostname: hostname:
description: description:

View file

@ -24,6 +24,7 @@ description:
either individual usernames or the aggregate of usernames in the either individual usernames or the aggregate of usernames in the
current running config. It also supports purging usernames from the current running config. It also supports purging usernames from the
configuration that are not explicitly defined. configuration that are not explicitly defined.
extends_documentation_fragment: network_agnostic
options: options:
aggregate: aggregate:
description: description:

View file

@ -0,0 +1,27 @@
# Copyright (c) 2019 Ansible, Inc
#
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
class ModuleDocFragment(object):
# Standard files documentation fragment
DOCUMENTATION = '''
options: {}
notes:
- This module is supported on C(ansible_network_os) network platforms. See
the :ref:`Network Platform Options <platform_options>` for details.
'''