summaryrefslogtreecommitdiff
path: root/lib/ansible/plugins/cliconf
diff options
context:
space:
mode:
authorNathaniel Case <this.is@nathanielca.se>2019-02-08 11:04:05 -0500
committerGitHub <noreply@github.com>2019-02-08 11:04:05 -0500
commit7ad238b35813f2191172dabb32e00a3b533a58a3 (patch)
tree9e82ebc725ec80fc1c851c78b6b03969721437a0 /lib/ansible/plugins/cliconf
parentd1b2ef9c5ce13b05f820c84b841e67eb5ee1aff7 (diff)
downloadansible-7ad238b35813f2191172dabb32e00a3b533a58a3.tar.gz
Document httpapi and cliconf plugins (#49503)
* Create new documentation pages for httpapi and cliconf * Add new documentation to plugins toctree and Makefile * Add DOCUMENTATION to cliconf * Apply suggestions from code review
Diffstat (limited to 'lib/ansible/plugins/cliconf')
-rw-r--r--lib/ansible/plugins/cliconf/aireos.py10
-rw-r--r--lib/ansible/plugins/cliconf/aruba.py10
-rw-r--r--lib/ansible/plugins/cliconf/asa.py10
-rw-r--r--lib/ansible/plugins/cliconf/ce.py10
-rw-r--r--lib/ansible/plugins/cliconf/cnos.py10
-rw-r--r--lib/ansible/plugins/cliconf/dellos10.py10
-rw-r--r--lib/ansible/plugins/cliconf/dellos6.py10
-rw-r--r--lib/ansible/plugins/cliconf/dellos9.py10
-rw-r--r--lib/ansible/plugins/cliconf/edgeos.py10
-rw-r--r--lib/ansible/plugins/cliconf/edgeswitch.py10
-rw-r--r--lib/ansible/plugins/cliconf/enos.py10
-rw-r--r--lib/ansible/plugins/cliconf/eos.py8
-rw-r--r--lib/ansible/plugins/cliconf/exos.py10
-rw-r--r--lib/ansible/plugins/cliconf/frr.py4
-rw-r--r--lib/ansible/plugins/cliconf/ios.py11
-rw-r--r--lib/ansible/plugins/cliconf/iosxr.py11
-rw-r--r--lib/ansible/plugins/cliconf/ironware.py10
-rw-r--r--lib/ansible/plugins/cliconf/junos.py11
-rw-r--r--lib/ansible/plugins/cliconf/nos.py10
-rw-r--r--lib/ansible/plugins/cliconf/nxos.py11
-rw-r--r--lib/ansible/plugins/cliconf/onyx.py10
-rw-r--r--lib/ansible/plugins/cliconf/routeros.py10
-rw-r--r--lib/ansible/plugins/cliconf/slxos.py10
-rw-r--r--lib/ansible/plugins/cliconf/voss.py10
-rw-r--r--lib/ansible/plugins/cliconf/vyos.py11
25 files changed, 241 insertions, 6 deletions
diff --git a/lib/ansible/plugins/cliconf/aireos.py b/lib/ansible/plugins/cliconf/aireos.py
index bad7f50339..453683f449 100644
--- a/lib/ansible/plugins/cliconf/aireos.py
+++ b/lib/ansible/plugins/cliconf/aireos.py
@@ -19,6 +19,16 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+cliconf: aireos
+short_description: Use aireos cliconf to run command on Cisco WLC platform
+description:
+ - This aireos plugin provides low level abstraction apis for
+ sending and receiving CLI commands from Cisco WLC network devices.
+version_added: 2.4
+"""
+
import re
import json
diff --git a/lib/ansible/plugins/cliconf/aruba.py b/lib/ansible/plugins/cliconf/aruba.py
index c8c3045ac7..e8e0674336 100644
--- a/lib/ansible/plugins/cliconf/aruba.py
+++ b/lib/ansible/plugins/cliconf/aruba.py
@@ -19,6 +19,16 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+cliconf: aruba
+short_description: Use aruba cliconf to run command on Aruba platform
+description:
+ - This aruba plugin provides low level abstraction apis for
+ sending and receiving CLI commands from Aruba network devices.
+version_added: 2.4
+"""
+
import re
import json
diff --git a/lib/ansible/plugins/cliconf/asa.py b/lib/ansible/plugins/cliconf/asa.py
index d0d23cad43..2c12fcff30 100644
--- a/lib/ansible/plugins/cliconf/asa.py
+++ b/lib/ansible/plugins/cliconf/asa.py
@@ -19,6 +19,16 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+cliconf: asa
+short_description: Use asa cliconf to run command on Cisco ASA platform
+description:
+ - This asa plugin provides low level abstraction apis for
+ sending and receiving CLI commands from Cisco ASA network devices.
+version_added: 2.4
+"""
+
import re
import json
diff --git a/lib/ansible/plugins/cliconf/ce.py b/lib/ansible/plugins/cliconf/ce.py
index 6790860c8d..d10c30cbc3 100644
--- a/lib/ansible/plugins/cliconf/ce.py
+++ b/lib/ansible/plugins/cliconf/ce.py
@@ -19,6 +19,16 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+cliconf: ce
+short_description: Use ce cliconf to run command on HUAWEI CloudEngine platform
+description:
+ - This ce plugin provides low level abstraction apis for
+ sending and receiving CLI commands from HUAWEI CloudEngine network devices.
+version_added: 2.7
+"""
+
import re
import json
diff --git a/lib/ansible/plugins/cliconf/cnos.py b/lib/ansible/plugins/cliconf/cnos.py
index 187e49f00e..52fa83abd0 100644
--- a/lib/ansible/plugins/cliconf/cnos.py
+++ b/lib/ansible/plugins/cliconf/cnos.py
@@ -16,6 +16,16 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+cliconf: cnos
+short_description: Use cnos cliconf to run command on Lenovo CNOS platform
+description:
+ - This cnos plugin provides low level abstraction apis for
+ sending and receiving CLI commands from Lenovo CNOS network devices.
+version_added: 2.6
+"""
+
import re
import json
diff --git a/lib/ansible/plugins/cliconf/dellos10.py b/lib/ansible/plugins/cliconf/dellos10.py
index 2ed9982bbe..032d463323 100644
--- a/lib/ansible/plugins/cliconf/dellos10.py
+++ b/lib/ansible/plugins/cliconf/dellos10.py
@@ -21,6 +21,16 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+cliconf: dellos10
+short_description: Use dellos10 cliconf to run command on Dell OS10 platform
+description:
+ - This dellos10 plugin provides low level abstraction apis for
+ sending and receiving CLI commands from Dell OS10 network devices.
+version_added: 2.5
+"""
+
import re
import json
diff --git a/lib/ansible/plugins/cliconf/dellos6.py b/lib/ansible/plugins/cliconf/dellos6.py
index 746f253056..8bfe713905 100644
--- a/lib/ansible/plugins/cliconf/dellos6.py
+++ b/lib/ansible/plugins/cliconf/dellos6.py
@@ -21,6 +21,16 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+cliconf: dellos6
+short_description: Use dellos6 cliconf to run command on Dell OS6 platform
+description:
+ - This dellos6 plugin provides low level abstraction apis for
+ sending and receiving CLI commands from Dell OS6 network devices.
+version_added: 2.5
+"""
+
import re
import json
diff --git a/lib/ansible/plugins/cliconf/dellos9.py b/lib/ansible/plugins/cliconf/dellos9.py
index 2ea9d1fdf9..ee72acf1a8 100644
--- a/lib/ansible/plugins/cliconf/dellos9.py
+++ b/lib/ansible/plugins/cliconf/dellos9.py
@@ -21,6 +21,16 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+cliconf: dellos9
+short_description: Use dellos9 cliconf to run command on Dell OS9 platform
+description:
+ - This dellos9 plugin provides low level abstraction apis for
+ sending and receiving CLI commands from Dell OS9 network devices.
+version_added: 2.5
+"""
+
import re
import json
diff --git a/lib/ansible/plugins/cliconf/edgeos.py b/lib/ansible/plugins/cliconf/edgeos.py
index 970de0e33e..af23df9a6a 100644
--- a/lib/ansible/plugins/cliconf/edgeos.py
+++ b/lib/ansible/plugins/cliconf/edgeos.py
@@ -5,6 +5,16 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+cliconf: edgeos
+short_description: Use edgeos cliconf to run command on EdgeOS platform
+description:
+ - This edgeos plugin provides low level abstraction apis for
+ sending and receiving CLI commands from Ubiquiti EdgeOS network devices.
+version_added: "2.5"
+"""
+
import re
import json
diff --git a/lib/ansible/plugins/cliconf/edgeswitch.py b/lib/ansible/plugins/cliconf/edgeswitch.py
index 44903ccbf6..c080a2470b 100644
--- a/lib/ansible/plugins/cliconf/edgeswitch.py
+++ b/lib/ansible/plugins/cliconf/edgeswitch.py
@@ -19,6 +19,16 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+cliconf: edgeswitch
+short_description: Use edgeswitch cliconf to run command on EdgeSwitch platform
+description:
+ - This edgeswitch plugin provides low level abstraction apis for
+ sending and receiving CLI commands from Ubiquiti EdgeSwitch network devices.
+version_added: "2.8"
+"""
+
import re
import time
import json
diff --git a/lib/ansible/plugins/cliconf/enos.py b/lib/ansible/plugins/cliconf/enos.py
index 3c9267f3ef..272743f1c5 100644
--- a/lib/ansible/plugins/cliconf/enos.py
+++ b/lib/ansible/plugins/cliconf/enos.py
@@ -16,6 +16,16 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+cliconf: enos
+short_description: Use enos cliconf to run command on Lenovo ENOS platform
+description:
+ - This enos plugin provides low level abstraction apis for
+ sending and receiving CLI commands from Lenovo ENOS network devices.
+version_added: "2.5"
+"""
+
import re
import json
diff --git a/lib/ansible/plugins/cliconf/eos.py b/lib/ansible/plugins/cliconf/eos.py
index d5b1824086..f878a843ec 100644
--- a/lib/ansible/plugins/cliconf/eos.py
+++ b/lib/ansible/plugins/cliconf/eos.py
@@ -23,11 +23,11 @@ DOCUMENTATION = """
---
author: Ansible Networking Team
cliconf: eos
-short_description: Use eos cliconf to run command on eos platform
+short_description: Use eos cliconf to run command on Arista EOS platform
description:
- - This eos plugin provides low level abstraction api's for
- sending and receiving CLI commands from eos network devices.
-version_added: "2.7"
+ - This eos plugin provides low level abstraction apis for
+ sending and receiving CLI commands from Arista EOS network devices.
+version_added: "2.4"
options:
eos_use_sessions:
type: int
diff --git a/lib/ansible/plugins/cliconf/exos.py b/lib/ansible/plugins/cliconf/exos.py
index e87189f92e..72bc527d7d 100644
--- a/lib/ansible/plugins/cliconf/exos.py
+++ b/lib/ansible/plugins/cliconf/exos.py
@@ -19,6 +19,16 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+cliconf: exos
+short_description: Use exos cliconf to run command on Extreme EXOS platform
+description:
+ - This exos plugin provides low level abstraction apis for
+ sending and receiving CLI commands from Extreme EXOS network devices.
+version_added: "2.6"
+"""
+
import re
import json
diff --git a/lib/ansible/plugins/cliconf/frr.py b/lib/ansible/plugins/cliconf/frr.py
index e3201de7dd..be80b04aec 100644
--- a/lib/ansible/plugins/cliconf/frr.py
+++ b/lib/ansible/plugins/cliconf/frr.py
@@ -25,8 +25,8 @@ author: Ansible Networking Team
cliconf: frr
short_description: Use frr cliconf to run command on Free Range Routing platform
description:
- - This frr plugin provides low level abstraction api's for
- sending and receiving CLI commands from devices running frr.
+ - This frr plugin provides low level abstraction apis for
+ sending and receiving CLI commands from FRR network devices.
version_added: "2.8"
"""
diff --git a/lib/ansible/plugins/cliconf/ios.py b/lib/ansible/plugins/cliconf/ios.py
index a90b829c67..de1b6face2 100644
--- a/lib/ansible/plugins/cliconf/ios.py
+++ b/lib/ansible/plugins/cliconf/ios.py
@@ -19,6 +19,17 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+author: Ansible Networking Team
+cliconf: ios
+short_description: Use ios cliconf to run command on Cisco IOS platform
+description:
+ - This ios plugin provides low level abstraction apis for
+ sending and receiving CLI commands from Cisco IOS network devices.
+version_added: "2.4"
+"""
+
import re
import time
import json
diff --git a/lib/ansible/plugins/cliconf/iosxr.py b/lib/ansible/plugins/cliconf/iosxr.py
index d78e52f078..1e791c4b0c 100644
--- a/lib/ansible/plugins/cliconf/iosxr.py
+++ b/lib/ansible/plugins/cliconf/iosxr.py
@@ -19,6 +19,17 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+author: Ansible Networking Team
+cliconf: iosxr
+short_description: Use iosxr cliconf to run command on Cisco IOS XR platform
+description:
+ - This iosxr plugin provides low level abstraction apis for
+ sending and receiving CLI commands from Cisco IOS XR network devices.
+version_added: "2.4"
+"""
+
import re
import json
diff --git a/lib/ansible/plugins/cliconf/ironware.py b/lib/ansible/plugins/cliconf/ironware.py
index ebf24601f8..ecf35e8e48 100644
--- a/lib/ansible/plugins/cliconf/ironware.py
+++ b/lib/ansible/plugins/cliconf/ironware.py
@@ -19,6 +19,16 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+cliconf: ironware
+short_description: Use ironware cliconf to run command on Extreme Ironware platform
+description:
+ - This ironware plugin provides low level abstraction apis for
+ sending and receiving CLI commands from Extreme Ironware network devices.
+version_added: "2.5"
+"""
+
import re
import json
diff --git a/lib/ansible/plugins/cliconf/junos.py b/lib/ansible/plugins/cliconf/junos.py
index 548b1b37c3..a928fe8d1f 100644
--- a/lib/ansible/plugins/cliconf/junos.py
+++ b/lib/ansible/plugins/cliconf/junos.py
@@ -19,6 +19,17 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+author: Ansible Networking Team
+cliconf: junos
+short_description: Use junos cliconf to run command on Juniper Junos OS platform
+description:
+ - This junos plugin provides low level abstraction apis for
+ sending and receiving CLI commands from Juniper Junos OS network devices.
+version_added: "2.4"
+"""
+
import json
import re
diff --git a/lib/ansible/plugins/cliconf/nos.py b/lib/ansible/plugins/cliconf/nos.py
index f5e07ae7cd..558f60ae8b 100644
--- a/lib/ansible/plugins/cliconf/nos.py
+++ b/lib/ansible/plugins/cliconf/nos.py
@@ -19,6 +19,16 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+cliconf: nos
+short_description: Use nos cliconf to run command on Extreme NOS platform
+description:
+ - This nos plugin provides low level abstraction apis for
+ sending and receiving CLI commands from Extreme NOS network devices.
+version_added: "2.7"
+"""
+
import re
import json
diff --git a/lib/ansible/plugins/cliconf/nxos.py b/lib/ansible/plugins/cliconf/nxos.py
index b3b2480000..dac95a22af 100644
--- a/lib/ansible/plugins/cliconf/nxos.py
+++ b/lib/ansible/plugins/cliconf/nxos.py
@@ -19,6 +19,17 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+author: Ansible Networking Team
+cliconf: nxos
+short_description: Use nxos cliconf to run command on Cisco NX-OS platform
+description:
+ - This nxos plugin provides low level abstraction apis for
+ sending and receiving CLI commands from Cicso NX-OS network devices.
+version_added: "2.4"
+"""
+
import json
import re
diff --git a/lib/ansible/plugins/cliconf/onyx.py b/lib/ansible/plugins/cliconf/onyx.py
index 4d66bdaad7..8195634b65 100644
--- a/lib/ansible/plugins/cliconf/onyx.py
+++ b/lib/ansible/plugins/cliconf/onyx.py
@@ -19,6 +19,16 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+cliconf: onyx
+short_description: Use onyx cliconf to run command on Mellanox ONYX platform
+description:
+ - This onyx plugin provides low level abstraction apis for
+ sending and receiving CLI commands from Mellanox ONYX network devices.
+version_added: "2.5"
+"""
+
import json
from itertools import chain
diff --git a/lib/ansible/plugins/cliconf/routeros.py b/lib/ansible/plugins/cliconf/routeros.py
index 2c5a922766..38b73fe5b0 100644
--- a/lib/ansible/plugins/cliconf/routeros.py
+++ b/lib/ansible/plugins/cliconf/routeros.py
@@ -19,6 +19,16 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+cliconf: routeros
+short_description: Use routeros cliconf to run command on MikroTik RouterOS platform
+description:
+ - This routeros plugin provides low level abstraction apis for
+ sending and receiving CLI commands from MikroTik RouterOS network devices.
+version_added: "2.7"
+"""
+
import re
import json
diff --git a/lib/ansible/plugins/cliconf/slxos.py b/lib/ansible/plugins/cliconf/slxos.py
index 4cdbaedc7e..5c71e2d23a 100644
--- a/lib/ansible/plugins/cliconf/slxos.py
+++ b/lib/ansible/plugins/cliconf/slxos.py
@@ -19,6 +19,16 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+cliconf: slxos
+short_description: Use slxos cliconf to run command on Extreme SLX-OS platform
+description:
+ - This slxos plugin provides low level abstraction apis for
+ sending and receiving CLI commands from Extreme SLX-OS network devices.
+version_added: "2.6"
+"""
+
import re
import json
diff --git a/lib/ansible/plugins/cliconf/voss.py b/lib/ansible/plugins/cliconf/voss.py
index f105266819..7cf832d5ff 100644
--- a/lib/ansible/plugins/cliconf/voss.py
+++ b/lib/ansible/plugins/cliconf/voss.py
@@ -19,6 +19,16 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+cliconf: voss
+short_description: Use voss cliconf to run command on Extreme VOSS platform
+description:
+ - This voss plugin provides low level abstraction apis for
+ sending and receiving CLI commands from Extreme VOSS network devices.
+version_added: "2.7"
+"""
+
import re
import json
diff --git a/lib/ansible/plugins/cliconf/vyos.py b/lib/ansible/plugins/cliconf/vyos.py
index a5b9f42f9c..340849e0c6 100644
--- a/lib/ansible/plugins/cliconf/vyos.py
+++ b/lib/ansible/plugins/cliconf/vyos.py
@@ -19,6 +19,17 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+DOCUMENTATION = """
+---
+author: Ansible Networking Team
+cliconf: vyos
+short_description: Use vyos cliconf to run command on VyOS platform
+description:
+ - This vyos plugin provides low level abstraction apis for
+ sending and receiving CLI commands from VyOS network devices.
+version_added: "2.4"
+"""
+
import re
import json