ACI: Various changes to module documentation and guide (#36516)

* ACI: Various changes to module documentation and guide

This PR includes:
- We moved the object class information to the notes
- Add version information to guide chapters
- Add generic note to modules with reference to ACI guide
- Reference known issues in aci_rest documentation
- Remove module_utils function docs from modules
- Indicate which parameters are not required for querying all objects
- Added missing RETURN information

* Fix copyright strings

* Remove aci_domain_to_encap_pool.py for v2.5

* More updates

* PEP8 fix

* Improve listings of parameters/return values
This commit is contained in:
Dag Wieers 2018-02-21 19:35:59 +01:00 committed by GitHub
commit 7435e115e0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
87 changed files with 533 additions and 534 deletions

View file

@ -18,6 +18,7 @@ module: aci_vlan_pool
short_description: Manage VLAN pools on Cisco ACI fabrics (fvns:VlanInstP)
description:
- Manage VLAN pools on Cisco ACI fabrics.
notes:
- More information from the internal APIC class I(fvns:VlanInstP) at
U(https://developer.cisco.com/docs/apic-mim-ref/).
author:
@ -197,7 +198,7 @@ def main():
argument_spec = aci_argument_spec()
argument_spec.update(
description=dict(type='str', aliases=['descr']),
pool=dict(type='str', aliases=['name', 'pool_name']),
pool=dict(type='str', aliases=['name', 'pool_name']), # Not required for querying all objects
pool_allocation_mode=dict(type='str', aliases=['allocation_mode', 'mode'], choices=['dynamic', 'static']),
state=dict(type='str', default='present', choices=['absent', 'present', 'query']),
)
@ -238,20 +239,17 @@ def main():
aci.get_existing()
if state == 'present':
# Filter out module parameters with null values
aci.payload(
aci_class='fvnsVlanInstP',
class_config=dict(
allocMode=pool_allocation_mode,
descr=description,
name=pool,
)
),
)
# Generate config diff which will be used as POST request body
aci.get_diff(aci_class='fvnsVlanInstP')
# Submit changes if module not in check_mode and the proposed is different than existing
aci.post_config()
elif state == 'absent':