Clean up doc, removed required: false, add hard stop etc .. (#21265)

This commit is contained in:
Damien 2017-02-10 11:56:28 -08:00 committed by John R Barker
parent e246bd10ac
commit 2f6966965e

View file

@ -31,40 +31,35 @@ short_description: Manage AOS IP Pool
description: description:
- Apstra AOS Ip Pool module let you manage your IP Pool easily. You can create - Apstra AOS Ip Pool module let you manage your IP Pool easily. You can create
create and delete IP Pool by Name, ID or by using a JSON File. This module create and delete IP Pool by Name, ID or by using a JSON File. This module
is idempotent and support the I(check) mode. It's using the AOS REST API is idempotent and support the I(check) mode. It's using the AOS REST API.
requirements: requirements:
- "aos-pyez >= 0.6.0" - "aos-pyez >= 0.6.0"
options: options:
session: session:
description: description:
- An existing AOS session as obtained by aos_login module - An existing AOS session as obtained by aos_login module.
required: true required: true
name: name:
description: description:
- Name of the IP Pool to manage. - Name of the IP Pool to manage.
Only one of I(name), I(id) or I(content) can be set. Only one of I(name), I(id) or I(content) can be set.
required: false
id: id:
description: description:
- AOS Id of the IP Pool to manage (can't be used to create a new IP Pool), - AOS Id of the IP Pool to manage (can't be used to create a new IP Pool),
Only one of I(name), I(id) or I(content) can be set. Only one of I(name), I(id) or I(content) can be set.
required: false
content: content:
description: description:
- Datastructure of the IP Pool to create. The data can be in YAML / JSON or - Datastructure of the IP Pool to manage. The data can be in YAML / JSON or
directly a variable. It's the same datastructure that is returned directly a variable. It's the same datastructure that is returned
on success in I(value). on success in I(value).
required: false
state: state:
description: description:
- Indicate what is the expected state of the IP Pool (present or not) - Indicate what is the expected state of the IP Pool (present or not).
default: present default: present
choices: ['present', 'absent'] choices: ['present', 'absent']
required: false
subnets: subnets:
description: description:
- List of subnet that needs to be part of the IP Pool - List of subnet that needs to be part of the IP Pool.
required: false
''' '''
EXAMPLES = ''' EXAMPLES = '''