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
This commit is contained in:
John R Barker 2017-03-09 16:20:25 +00:00 committed by GitHub
commit e5b990a55a
138 changed files with 176 additions and 256 deletions

View file

@ -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.

View file

@ -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.

View file

@ -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" ]
'''

View file

@ -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

View file

@ -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.

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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 switchs startup configuration. The method provides a way to reset the

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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.

View file

@ -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

View file

@ -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.

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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,

View file

@ -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

View file

@ -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: