From 0775d39a87f066d7de9687eb059b911e6dd5cee6 Mon Sep 17 00:00:00 2001 From: John R Barker Date: Sun, 5 Mar 2017 08:37:01 +0000 Subject: [PATCH] Add extends_documentation_fragment back (#22293) --- lib/ansible/modules/network/eos/_eos_template.py | 1 + lib/ansible/modules/network/eos/eos_banner.py | 3 ++- lib/ansible/modules/network/eos/eos_command.py | 1 + lib/ansible/modules/network/eos/eos_config.py | 1 + lib/ansible/modules/network/eos/eos_eapi.py | 1 + lib/ansible/modules/network/eos/eos_facts.py | 1 + lib/ansible/modules/network/eos/eos_system.py | 1 + lib/ansible/modules/network/eos/eos_user.py | 1 + lib/ansible/modules/network/ios/_ios_template.py | 1 + lib/ansible/modules/network/ios/ios_command.py | 1 + lib/ansible/modules/network/ios/ios_config.py | 1 + lib/ansible/modules/network/ios/ios_facts.py | 1 + lib/ansible/modules/network/ios/ios_system.py | 1 + lib/ansible/modules/network/ios/ios_vrf.py | 1 + lib/ansible/modules/network/iosxr/_iosxr_template.py | 1 + lib/ansible/modules/network/iosxr/iosxr_command.py | 1 + lib/ansible/modules/network/iosxr/iosxr_config.py | 1 + lib/ansible/modules/network/iosxr/iosxr_facts.py | 1 + lib/ansible/modules/network/iosxr/iosxr_system.py | 1 + lib/ansible/modules/network/junos/junos_command.py | 1 + lib/ansible/modules/network/junos/junos_config.py | 1 + lib/ansible/modules/network/junos/junos_rpc.py | 1 + lib/ansible/modules/network/junos/junos_user.py | 1 + lib/ansible/modules/network/vyos/vyos_command.py | 1 + lib/ansible/modules/network/vyos/vyos_config.py | 1 + lib/ansible/modules/network/vyos/vyos_facts.py | 1 + lib/ansible/modules/network/vyos/vyos_system.py | 1 + 27 files changed, 28 insertions(+), 1 deletion(-) diff --git a/lib/ansible/modules/network/eos/_eos_template.py b/lib/ansible/modules/network/eos/_eos_template.py index f18f371846a..afe1c2ff2dd 100644 --- a/lib/ansible/modules/network/eos/_eos_template.py +++ b/lib/ansible/modules/network/eos/_eos_template.py @@ -34,6 +34,7 @@ description: by evaluating the current running-config and only pushing configuration commands that are not already configured. The config source can be a set of commands or a template. +extends_documentation_fragment: eos deprecated: Deprecated in 2.2. Use M(eos_config) instead options: src: diff --git a/lib/ansible/modules/network/eos/eos_banner.py b/lib/ansible/modules/network/eos/eos_banner.py index 6965b7caf9c..3469631c371 100644 --- a/lib/ansible/modules/network/eos/eos_banner.py +++ b/lib/ansible/modules/network/eos/eos_banner.py @@ -24,7 +24,7 @@ ANSIBLE_METADATA = { DOCUMENTATION = """ --- -module: eos_banner_ +module: eos_banner version_added: "2.3" author: "Peter Sprygada (@privateip)" short_description: Manage multiline banners on Arista EOS devices @@ -32,6 +32,7 @@ description: - This will configure both login and motd banners on remote devices running Arista EOS. It allows playbooks to add or remote banner text from the active running configuration. +extends_documentation_fragment: eos options: banner: description: diff --git a/lib/ansible/modules/network/eos/eos_command.py b/lib/ansible/modules/network/eos/eos_command.py index 3cba6faa98f..803998d9cb2 100644 --- a/lib/ansible/modules/network/eos/eos_command.py +++ b/lib/ansible/modules/network/eos/eos_command.py @@ -33,6 +33,7 @@ description: read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. +extends_documentation_fragment: eos options: commands: description: diff --git a/lib/ansible/modules/network/eos/eos_config.py b/lib/ansible/modules/network/eos/eos_config.py index e19232386d4..0fb61f74646 100644 --- a/lib/ansible/modules/network/eos/eos_config.py +++ b/lib/ansible/modules/network/eos/eos_config.py @@ -34,6 +34,7 @@ description: an implementation for working with eos configuration sections in a deterministic way. This module works with either CLI or eAPI transports. +extends_documentation_fragment: eos options: lines: description: diff --git a/lib/ansible/modules/network/eos/eos_eapi.py b/lib/ansible/modules/network/eos/eos_eapi.py index 36af7ea6c83..28c2619b3f9 100644 --- a/lib/ansible/modules/network/eos/eos_eapi.py +++ b/lib/ansible/modules/network/eos/eos_eapi.py @@ -38,6 +38,7 @@ description: Unix socket server. Use the options listed below to override the default configuration. - Requires EOS v4.12 or greater. +extends_documentation_fragment: eos options: http: description: diff --git a/lib/ansible/modules/network/eos/eos_facts.py b/lib/ansible/modules/network/eos/eos_facts.py index 32da3e069bd..63754abf445 100644 --- a/lib/ansible/modules/network/eos/eos_facts.py +++ b/lib/ansible/modules/network/eos/eos_facts.py @@ -34,6 +34,7 @@ description: base network fact keys with C(ansible_net_). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts. +extends_documentation_fragment: eos options: gather_subset: description: diff --git a/lib/ansible/modules/network/eos/eos_system.py b/lib/ansible/modules/network/eos/eos_system.py index b1d1cd88c3c..39b1b147045 100644 --- a/lib/ansible/modules/network/eos/eos_system.py +++ b/lib/ansible/modules/network/eos/eos_system.py @@ -33,6 +33,7 @@ description: on Arista EOS devices. It provides an option to configure host system parameters or remove those parameters from the device active configuration. +extends_documentation_fragment: eos options: hostname: description: diff --git a/lib/ansible/modules/network/eos/eos_user.py b/lib/ansible/modules/network/eos/eos_user.py index 51feb3506f3..775f76a79ea 100644 --- a/lib/ansible/modules/network/eos/eos_user.py +++ b/lib/ansible/modules/network/eos/eos_user.py @@ -32,6 +32,7 @@ description: either individual usernames or the collection of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined. +extends_documentation_fragment: eos options: users: description: diff --git a/lib/ansible/modules/network/ios/_ios_template.py b/lib/ansible/modules/network/ios/_ios_template.py index 9ca21037ee2..9ad44f5f4d4 100644 --- a/lib/ansible/modules/network/ios/_ios_template.py +++ b/lib/ansible/modules/network/ios/_ios_template.py @@ -35,6 +35,7 @@ description: commands that are not already configured. The config source can be a set of commands or a template. deprecated: Deprecated in 2.2. Use M(ios_config) instead. +extends_documentation_fragment: ios options: src: description: diff --git a/lib/ansible/modules/network/ios/ios_command.py b/lib/ansible/modules/network/ios/ios_command.py index a93d9b58ab4..1d9fd844fdd 100644 --- a/lib/ansible/modules/network/ios/ios_command.py +++ b/lib/ansible/modules/network/ios/ios_command.py @@ -35,6 +35,7 @@ description: before returning or timing out if the condition is not met. - This module does not support running commands in configuration mode. Please use M(ios_config) to configure IOS devices. +extends_documentation_fragment: ios options: commands: description: diff --git a/lib/ansible/modules/network/ios/ios_config.py b/lib/ansible/modules/network/ios/ios_config.py index 1a5de3844c7..359a4694b98 100644 --- a/lib/ansible/modules/network/ios/ios_config.py +++ b/lib/ansible/modules/network/ios/ios_config.py @@ -33,6 +33,7 @@ description: for segmenting configuration into sections. This module provides an implementation for working with IOS configuration sections in a deterministic way. +extends_documentation_fragment: ios options: lines: description: diff --git a/lib/ansible/modules/network/ios/ios_facts.py b/lib/ansible/modules/network/ios/ios_facts.py index 79da719b2ce..d5f4ce507c5 100644 --- a/lib/ansible/modules/network/ios/ios_facts.py +++ b/lib/ansible/modules/network/ios/ios_facts.py @@ -33,6 +33,7 @@ description: base network fact keys with C(ansible_net_). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts. +extends_documentation_fragment: ios options: gather_subset: description: diff --git a/lib/ansible/modules/network/ios/ios_system.py b/lib/ansible/modules/network/ios/ios_system.py index 1bc6edb53d7..e243e1e13b9 100644 --- a/lib/ansible/modules/network/ios/ios_system.py +++ b/lib/ansible/modules/network/ios/ios_system.py @@ -33,6 +33,7 @@ description: on Cisco IOS devices. It provides an option to configure host system parameters or remove those parameters from the device active configuration. +extends_documentation_fragment: ios options: hostname: description: diff --git a/lib/ansible/modules/network/ios/ios_vrf.py b/lib/ansible/modules/network/ios/ios_vrf.py index 5ee2dc3f909..cfced8f988d 100644 --- a/lib/ansible/modules/network/ios/ios_vrf.py +++ b/lib/ansible/modules/network/ios/ios_vrf.py @@ -33,6 +33,7 @@ description: Cisco IOS devices. It allows playbooks to manage individual or the entire VRF collection. It also supports purging VRF definitions from the configuration that are not explicitly defined. +extends_documentation_fragment: ios options: vrfs: description: diff --git a/lib/ansible/modules/network/iosxr/_iosxr_template.py b/lib/ansible/modules/network/iosxr/_iosxr_template.py index 15d9cf4f430..aa4f3a90880 100644 --- a/lib/ansible/modules/network/iosxr/_iosxr_template.py +++ b/lib/ansible/modules/network/iosxr/_iosxr_template.py @@ -34,6 +34,7 @@ description: commands that are not already configured. The config source can be a set of commands or a template. deprecated: Deprecated in 2.2. Use M(iosxr_config) instead. +extends_documentation_fragment: iosxr options: src: description: diff --git a/lib/ansible/modules/network/iosxr/iosxr_command.py b/lib/ansible/modules/network/iosxr/iosxr_command.py index 06d52508efa..d1bb0fe1794 100644 --- a/lib/ansible/modules/network/iosxr/iosxr_command.py +++ b/lib/ansible/modules/network/iosxr/iosxr_command.py @@ -33,6 +33,7 @@ description: before returning or timing out if the condition is not met. - This module does not support running commands in configuration mode. Please use M(iosxr_config) to configure iosxr devices. +extends_documentation_fragment: iosxr options: commands: description: diff --git a/lib/ansible/modules/network/iosxr/iosxr_config.py b/lib/ansible/modules/network/iosxr/iosxr_config.py index f2501c7b128..7bad5ec7624 100644 --- a/lib/ansible/modules/network/iosxr/iosxr_config.py +++ b/lib/ansible/modules/network/iosxr/iosxr_config.py @@ -31,6 +31,7 @@ description: for segmenting configuration into sections. This module provides an implementation for working with IOS XR configuration sections in a deterministic way. +extends_documentation_fragment: iosxr options: lines: description: diff --git a/lib/ansible/modules/network/iosxr/iosxr_facts.py b/lib/ansible/modules/network/iosxr/iosxr_facts.py index 6ac17dc3aa0..22a36443371 100644 --- a/lib/ansible/modules/network/iosxr/iosxr_facts.py +++ b/lib/ansible/modules/network/iosxr/iosxr_facts.py @@ -31,6 +31,7 @@ description: base network fact keys with C(ansible_net_). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts. +extends_documentation_fragment: iosxr options: gather_subset: description: diff --git a/lib/ansible/modules/network/iosxr/iosxr_system.py b/lib/ansible/modules/network/iosxr/iosxr_system.py index c04ec9f41bc..0e4ad5001af 100644 --- a/lib/ansible/modules/network/iosxr/iosxr_system.py +++ b/lib/ansible/modules/network/iosxr/iosxr_system.py @@ -33,6 +33,7 @@ description: on Cisco IOS-XR devices. It provides an option to configure host system parameters or remove those parameters from the device active configuration. +extends_documentation_fragment: iosxr options: hostname: description: diff --git a/lib/ansible/modules/network/junos/junos_command.py b/lib/ansible/modules/network/junos/junos_command.py index 276384b860a..d043200e096 100644 --- a/lib/ansible/modules/network/junos/junos_command.py +++ b/lib/ansible/modules/network/junos/junos_command.py @@ -33,6 +33,7 @@ description: read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. +extends_documentation_fragment: junos options: commands: description: diff --git a/lib/ansible/modules/network/junos/junos_config.py b/lib/ansible/modules/network/junos/junos_config.py index afe69ccad83..f3815dc46f4 100644 --- a/lib/ansible/modules/network/junos/junos_config.py +++ b/lib/ansible/modules/network/junos/junos_config.py @@ -33,6 +33,7 @@ description: configuration running on Juniper JUNOS devices. It provides a set of arguments for loading configuration, performing rollback operations and zeroing the active configuration on the device. +extends_documentation_fragment: junos options: lines: description: diff --git a/lib/ansible/modules/network/junos/junos_rpc.py b/lib/ansible/modules/network/junos/junos_rpc.py index 7ce754be0e9..09876cbf807 100644 --- a/lib/ansible/modules/network/junos/junos_rpc.py +++ b/lib/ansible/modules/network/junos/junos_rpc.py @@ -33,6 +33,7 @@ description: specified RPC using the NetConf transport. The reply is then returned to the playbook in the c(xml) key. If an alternate output format is requested, the reply is transformed to the requested output. +extends_documentation_fragment: junos options: rpc: description: diff --git a/lib/ansible/modules/network/junos/junos_user.py b/lib/ansible/modules/network/junos/junos_user.py index 032f2612677..eb5c85c7ad5 100644 --- a/lib/ansible/modules/network/junos/junos_user.py +++ b/lib/ansible/modules/network/junos/junos_user.py @@ -33,6 +33,7 @@ description: network devices running the JUNOS operating system. It provides a set of arguments for creating, removing and updating locally defined accounts +extends_documentation_fragment: junos options: users: description: diff --git a/lib/ansible/modules/network/vyos/vyos_command.py b/lib/ansible/modules/network/vyos/vyos_command.py index 6fbe9be89ad..c64895ea15b 100644 --- a/lib/ansible/modules/network/vyos/vyos_command.py +++ b/lib/ansible/modules/network/vyos/vyos_command.py @@ -38,6 +38,7 @@ description: use a custom pager that can cause this module to hang. If the value of the environment variable C(ANSIBLE_VYOS_TERMINAL_LENGTH) is not set, the default number of 10000 is used. +extends_documentation_fragment: vyos options: commands: description: diff --git a/lib/ansible/modules/network/vyos/vyos_config.py b/lib/ansible/modules/network/vyos/vyos_config.py index 514bde1d378..c2cb45b31e2 100644 --- a/lib/ansible/modules/network/vyos/vyos_config.py +++ b/lib/ansible/modules/network/vyos/vyos_config.py @@ -34,6 +34,7 @@ description: configuration file and state of the active configuration. All configuration statements are based on `set` and `delete` commands in the device configuration. +extends_documentation_fragment: vyos options: lines: description: diff --git a/lib/ansible/modules/network/vyos/vyos_facts.py b/lib/ansible/modules/network/vyos/vyos_facts.py index b79c5287bff..909ab049ba2 100644 --- a/lib/ansible/modules/network/vyos/vyos_facts.py +++ b/lib/ansible/modules/network/vyos/vyos_facts.py @@ -33,6 +33,7 @@ description: base network fact keys with U(ansible_net_). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts. +extends_documentation_fragment: vyos options: gather_subset: description: diff --git a/lib/ansible/modules/network/vyos/vyos_system.py b/lib/ansible/modules/network/vyos/vyos_system.py index 0cb6dfa0d69..d35fb1dfa37 100644 --- a/lib/ansible/modules/network/vyos/vyos_system.py +++ b/lib/ansible/modules/network/vyos/vyos_system.py @@ -33,6 +33,7 @@ description: - Runs one or more commands on remote devices running VyOS. This module can also be introspected to validate key parameters before returning successfully. +extends_documentation_fragment: vyos options: hostname: description: