Fix invalid fields in module DOCUMENATION (#22297)

* fix module doc fields * More module docs corrections * More module docs corrections * More module docs corrections * More module docs corrections * correct aliases * Review comments * Must quote ':' * More authors * Use suboptions: * restore type: bool * type should be in the same place * More tidyups * authors * Use suboptions * revert * remove duplicate author * More issues post rebase
2025-07-24 05:40:23 -07:00 · 2017-03-09 16:20:25 +00:00 · 2017-03-09 16:20:25 +00:00 · e5b990a55a
commit e5b990a55a
parent 000ca2a2bc
138 changed files with 176 additions and 256 deletions
--- a/lib/ansible/modules/network/bigswitch/bigmon_chain.py
+++ b/lib/ansible/modules/network/bigswitch/bigmon_chain.py
@ -26,6 +26,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
 DOCUMENTATION = '''
 ---
 module: bigmon_chain
+author: "Ted (@tedelhourani)"
 short_description: Create and remove a bigmon inline service chain.
 description:
    - Create and remove a bigmon inline service chain.
--- a/lib/ansible/modules/network/bigswitch/bigmon_policy.py
+++ b/lib/ansible/modules/network/bigswitch/bigmon_policy.py
@ -26,6 +26,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
 DOCUMENTATION = '''
 ---
 module: bigmon_policy
+author: "Ted (@tedelhourani)"
 short_description: Create and remove a bigmon out-of-band policy.
 description:
    - Create and remove a bigmon out-of-band policy.
--- a/lib/ansible/modules/network/illumos/dladm_linkprop.py
+++ b/lib/ansible/modules/network/illumos/dladm_linkprop.py
@ -35,32 +35,28 @@ options:
    link:
        description:
            - Link interface name.
-        type: str
        required: true
        aliases: [ "nic", "interface" ]
    property:
        description:
            - Specifies the name of the property we want to manage.
-        type: str
        required: true
        aliases: [ "name" ]
    value:
        description:
            - Specifies the value we want to set for the link property.
-        type: str
        required: false
    temporary:
        description:
            - Specifies that lin property configuration is temporary. Temporary
              link property configuration does not persist across reboots.
        required: false
-        type: boolean
+        type: bool
        default: false
    state:
        description:
            - Set or reset the property value.
        required: false
-        type: str
        default: "present"
        choices: [ "present", "absent", "reset" ]
 '''
--- a/lib/ansible/modules/network/lenovo/cnos_backup.py
+++ b/lib/ansible/modules/network/lenovo/cnos_backup.py
@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
 DOCUMENTATION = '''
 ---
 module: cnos_backup
+author: "Dave Kasberg (@dkasberg)"
 short_description: Backup the current running or startup configuration to a remote server on devices running Lenovo CNOS
 description:
    - This module allows you to work with switch configurations. It provides a
--- a/lib/ansible/modules/network/lenovo/cnos_bgp.py
+++ b/lib/ansible/modules/network/lenovo/cnos_bgp.py
@ -28,6 +28,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
 DOCUMENTATION = '''
 ---
 module: cnos_bgp
+author: "Dave Kasberg (@dkasberg)"
 short_description: Manage BGP resources and attributes on devices running Lenovo CNOS
 description:
    - This module allows you to work with Border Gateway Protocol (BGP) related configurations.
--- a/lib/ansible/modules/network/lenovo/cnos_command.py
+++ b/lib/ansible/modules/network/lenovo/cnos_command.py
@ -30,6 +30,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
 DOCUMENTATION = '''
 ---
 module: cnos_command
+author: "Dave Kasberg (@dkasberg)"
 short_description: Execute a single command on devices running Lenovo CNOS
 description:
    - This module allows you to modify the switch running configuration. It provides a way to
--- a/lib/ansible/modules/network/lenovo/cnos_conditional_command.py
+++ b/lib/ansible/modules/network/lenovo/cnos_conditional_command.py
@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
 DOCUMENTATION = '''
 ---
 module: cnos_conditional_command
+author: "Dave Kasberg (@dkasberg)"
 short_description: Execute a single command based on condition on devices running Lenovo CNOS
 description:
   - This module allows you to modify the running configuration of a switch. It provides a way to
--- a/lib/ansible/modules/network/lenovo/cnos_conditional_template.py
+++ b/lib/ansible/modules/network/lenovo/cnos_conditional_template.py
@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
 DOCUMENTATION = '''
 ---
 module: cnos_conditional_template
+author: "Dave Kasberg (@dkasberg)"
 short_description: Manage switch configuration using templates based on condition on devices running Lenovo CNOS
 description:
    - This module allows you to work with the running configuration of a switch. It provides a way to
--- a/lib/ansible/modules/network/lenovo/cnos_factory.py
+++ b/lib/ansible/modules/network/lenovo/cnos_factory.py
@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
 DOCUMENTATION = '''
 ---
 module: cnos_factory
+author: "Dave Kasberg (@dkasberg)"
 short_description: Reset the switch's startup configuration to default (factory) on devices running Lenovo CNOS
 description:
    - This module allows you to reset a switch’s startup configuration. The method provides a way to reset the
--- a/lib/ansible/modules/network/lenovo/cnos_facts.py
+++ b/lib/ansible/modules/network/lenovo/cnos_facts.py
@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
 DOCUMENTATION = '''
 ---
 module: cnos_facts
+author: "Dave Kasberg (@dkasberg)"
 short_description: Collect facts on devices running Lenovo CNOS
 description:
    - This module allows you to view the switch information. It executes the show sysinfo CLI command on a switch
--- a/lib/ansible/modules/network/lenovo/cnos_image.py
+++ b/lib/ansible/modules/network/lenovo/cnos_image.py
@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
 DOCUMENTATION = '''
 ---
 module: cnos_image
+author: "Dave Kasberg (@dkasberg)"
 short_description: Perform firmware upgrade/download from a remote server on devices running Lenovo CNOS
 description:
    - This module allows you to work with switch firmware images. It provides a way to download a firmware image
--- a/lib/ansible/modules/network/lenovo/cnos_interface.py
+++ b/lib/ansible/modules/network/lenovo/cnos_interface.py
@ -28,6 +28,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
 DOCUMENTATION = '''
 ---
 module: cnos_interface
+author: "Dave Kasberg (@dkasberg)"
 short_description: Manage interface configuration on devices running Lenovo CNOS
 description:
    - This module allows you to work with interface related configurations. The operators used are
--- a/lib/ansible/modules/network/lenovo/cnos_portchannel.py
+++ b/lib/ansible/modules/network/lenovo/cnos_portchannel.py
@ -28,6 +28,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
 DOCUMENTATION = '''
 ---
 module: cnos_portchannel
+author: "Dave Kasberg (@dkasberg)"
 short_description: Manage portchannel (port aggregation) configuration on devices running Lenovo CNOS
 description:
    - This module allows you to work with port aggregation related configurations. The operators
--- a/lib/ansible/modules/network/lenovo/cnos_reload.py
+++ b/lib/ansible/modules/network/lenovo/cnos_reload.py
@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
 DOCUMENTATION = '''
 ---
 module: cnos_reload
+author: "Dave Kasberg (@dkasberg)"
 short_description: Perform switch restart on devices running Lenovo CNOS
 description:
    - This module allows you to restart the switch using the current startup configuration.
--- a/lib/ansible/modules/network/lenovo/cnos_rollback.py
+++ b/lib/ansible/modules/network/lenovo/cnos_rollback.py
@ -30,6 +30,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
 DOCUMENTATION = '''
 ---
 module: cnos_rollback
+author: "Dave Kasberg (@dkasberg)"
 short_description: Roll back the running or startup configuration from a remote server on devices running Lenovo CNOS
 description:
    - This module allows you to work with switch configurations. It provides a way to roll back configurations
--- a/lib/ansible/modules/network/lenovo/cnos_save.py
+++ b/lib/ansible/modules/network/lenovo/cnos_save.py
@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
 DOCUMENTATION = '''
 ---
 module: cnos_save
+author: "Dave Kasberg (@dkasberg)"
 short_description: Save the running configuration as the startup configuration on devices running Lenovo CNOS
 description:
    - This module allows you to copy the running configuration of a switch over its startup configuration.
--- a/lib/ansible/modules/network/lenovo/cnos_showrun.py
+++ b/lib/ansible/modules/network/lenovo/cnos_showrun.py
@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
 DOCUMENTATION = '''
 ---
 module: cnos_showrun
+author: "Dave Kasberg (@dkasberg)"
 short_description: Collect the current running configuration on devices running Lenovo CNOS
 description:
    - This module allows you to view the switch running configuration. It executes the display running-config CLI
--- a/lib/ansible/modules/network/lenovo/cnos_template.py
+++ b/lib/ansible/modules/network/lenovo/cnos_template.py
@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
 DOCUMENTATION = '''
 ---
 module: cnos_template
+author: "Dave Kasberg (@dkasberg)"
 short_description: Manage switch configuration using templates on devices running Lenovo CNOS
 description:
    - This module allows you to work with the running configuration of a switch. It provides a way
--- a/lib/ansible/modules/network/lenovo/cnos_vlag.py
+++ b/lib/ansible/modules/network/lenovo/cnos_vlag.py
@ -29,6 +29,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
 DOCUMENTATION = '''
 ---
 module: cnos_vlag
+author: "Dave Kasberg (@dkasberg)"
 short_description: Manage VLAG resources and attributes on devices running Lenovo CNOS
 description:
    - This module allows you to work with virtual Link Aggregation Groups
--- a/lib/ansible/modules/network/lenovo/cnos_vlan.py
+++ b/lib/ansible/modules/network/lenovo/cnos_vlan.py
@ -30,6 +30,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
 DOCUMENTATION = '''
 ---
 module: cnos_vlan
+author: "Dave Kasberg (@dkasberg)"
 short_description: Manage VLAN resources and attributes on devices running Lenovo CNOS
 description:
    - This module allows you to work with VLAN related configurations. The
--- a/lib/ansible/modules/network/netvisor/pn_cluster.py
+++ b/lib/ansible/modules/network/netvisor/pn_cluster.py
@ -27,7 +27,6 @@ DOCUMENTATION = """
 module: pn_cluster
 author: "Pluribus Networks (@amitsi)"
 version_added: "2.2"
-version: 1.0
 short_description: CLI command to create/delete a cluster.
 description:
  - Execute cluster-create or cluster-delete command.
--- a/lib/ansible/modules/network/netvisor/pn_ospf.py
+++ b/lib/ansible/modules/network/netvisor/pn_ospf.py
@ -27,7 +27,6 @@ DOCUMENTATION = """
 module: pn_ospf
 author: "Pluribus Networks (@amitsi)"
 version_added: "2.2"
-version: 1.0
 short_description: CLI command to add/remove ospf protocol to a vRouter.
 description:
  - Execute vrouter-ospf-add, vrouter-ospf-remove command.
--- a/lib/ansible/modules/network/netvisor/pn_ospfarea.py
+++ b/lib/ansible/modules/network/netvisor/pn_ospfarea.py
@ -27,7 +27,6 @@ DOCUMENTATION = """
 module: pn_ospfarea
 author: "Pluribus Networks (@amitsi)"
 version_added: "2.2"
-version: 1.0
 short_description: CLI command to add/remove ospf area to/from a vrouter.
 description:
  - Execute vrouter-ospf-add, vrouter-ospf-remove command.
--- a/lib/ansible/modules/network/netvisor/pn_show.py
+++ b/lib/ansible/modules/network/netvisor/pn_show.py
@ -27,7 +27,6 @@ DOCUMENTATION = """
 module: pn_show
 author: "Pluribus Networks (@amitsi)"
 version_added: "2.2"
-version: 1.0
 short_description: Run show commands on nvOS device.
 description:
  - Execute show command in the nodes and returns the results
--- a/lib/ansible/modules/network/netvisor/pn_trunk.py
+++ b/lib/ansible/modules/network/netvisor/pn_trunk.py
@ -27,7 +27,6 @@ DOCUMENTATION = """
 module: pn_trunk
 author: "Pluribus Networks (@amitsi)"
 version_added: "2.2"
-version: 1.0
 short_description: CLI command to create/delete/modify a trunk.
 description:
  - Execute trunk-create or trunk-delete command.
--- a/lib/ansible/modules/network/netvisor/pn_vlag.py
+++ b/lib/ansible/modules/network/netvisor/pn_vlag.py
@ -27,7 +27,6 @@ DOCUMENTATION = """
 module: pn_vlag
 author: "Pluribus Networks (@amitsi)"
 version_added: "2.2"
-version: 1.0
 short_description: CLI command to create/delete/modify vlag.
 description:
  - Execute vlag-create/vlag-delete/vlag-modify command.
--- a/lib/ansible/modules/network/netvisor/pn_vlan.py
+++ b/lib/ansible/modules/network/netvisor/pn_vlan.py
@ -27,7 +27,6 @@ DOCUMENTATION = """
 module: pn_vlan
 author: "Pluribus Networks (@amitsi)"
 version_added: "2.2"
-version: 1.0
 short_description: CLI command to create/delete a VLAN.
 description:
  - Execute vlan-create or vlan-delete command.
--- a/lib/ansible/modules/network/netvisor/pn_vrouter.py
+++ b/lib/ansible/modules/network/netvisor/pn_vrouter.py
@ -27,7 +27,6 @@ DOCUMENTATION = """
 module: pn_vrouter
 author: "Pluribus Networks (@amitsi)"
 version_added: "2.2"
-version: 1
 short_description: CLI command to create/delete/modify a vrouter.
 description:
  - Execute vrouter-create, vrouter-delete, vrouter-modify command.
--- a/lib/ansible/modules/network/netvisor/pn_vrouterbgp.py
+++ b/lib/ansible/modules/network/netvisor/pn_vrouterbgp.py
@ -27,7 +27,6 @@ DOCUMENTATION = """
 module: pn_vrouterbgp
 author: "Pluribus Networks (@amitsi)"
 version_added: "2.2"
-version: 1.0
 short_description: CLI command to add/remove/modify vrouter-bgp.
 description:
  - Execute vrouter-bgp-add, vrouter-bgp-remove, vrouter-bgp-modify command.
--- a/lib/ansible/modules/network/netvisor/pn_vrouterif.py
+++ b/lib/ansible/modules/network/netvisor/pn_vrouterif.py
@ -27,7 +27,6 @@ DOCUMENTATION = """
 module: pn_vrouterif
 author: "Pluribus Networks (@amitsi)"
 version_added: "2.2"
-version: 1.0
 short_description: CLI command to add/remove/modify vrouter-interface.
 description:
  - Execute vrouter-interface-add, vrouter-interface-remove,
--- a/lib/ansible/modules/network/netvisor/pn_vrouterlbif.py
+++ b/lib/ansible/modules/network/netvisor/pn_vrouterlbif.py
@ -27,7 +27,6 @@ DOCUMENTATION = """
 module: pn_vrouterlbif
 author: "Pluribus Networks (@amitsi)"
 version_added: "2.2"
-version: 1.0
 short_description: CLI command to add/remove vrouter-loopback-interface.
 description:
  - Execute vrouter-loopback-interface-add, vrouter-loopback-interface-remove
--- a/lib/ansible/modules/network/panos/panos_interface.py
+++ b/lib/ansible/modules/network/panos/panos_interface.py
@ -33,7 +33,7 @@ author: "Luigi Mori (@jtschichold), Ivan Bojer (@ivanbojer)"
 version_added: "2.3"
 requirements:
    - pan-python can be obtained from PyPi U(https://pypi.python.org/pypi/pan-python)
-note:
+notes:
    - Checkmode is not supported.
 options:
    ip_address: