diff options
| author | Dag Wieers <dag@wieers.com> | 2018-03-15 22:15:24 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-03-15 22:15:24 +0100 |
| commit | cdd21e2170b9a47d84624c8c2f792a66f2b0fe57 (patch) | |
| tree | 29a518e9b19c8e43f9ef7eeccb6114e5ad9a5d55 /lib/ansible/modules/cloud/openstack/os_router.py | |
| parent | 58eb2e849d6e1b7c23b0f4b25e4dd3af1a1fd4d4 (diff) | |
| download | ansible-cdd21e2170b9a47d84624c8c2f792a66f2b0fe57.tar.gz | |
Clean up module documentation (#36909)
* Clean up module documentation
This PR includes:
- Removal of `default: None` (and variations)
- Removal of `required: false`
- Fixing booleans and `type: bool` where required
* Fix remaining (new) validation issues
Diffstat (limited to 'lib/ansible/modules/cloud/openstack/os_router.py')
| -rw-r--r-- | lib/ansible/modules/cloud/openstack/os_router.py | 18 |
1 files changed, 4 insertions, 14 deletions
diff --git a/lib/ansible/modules/cloud/openstack/os_router.py b/lib/ansible/modules/cloud/openstack/os_router.py index fe5a6cb0d5..ce983b320c 100644 --- a/lib/ansible/modules/cloud/openstack/os_router.py +++ b/lib/ansible/modules/cloud/openstack/os_router.py @@ -36,24 +36,20 @@ options: admin_state_up: description: - Desired admin state of the created or existing router. - required: false - default: true + type: bool + default: 'yes' enable_snat: description: - Enable Source NAT (SNAT) attribute. - required: false - default: true + type: bool + default: 'yes' network: description: - Unique name or ID of the external gateway network. - required I(interfaces) or I(enable_snat) are provided. - required: false - default: None project: description: - Unique name or ID of the project. - required: false - default: None version_added: "2.2" external_fixed_ips: description: @@ -61,8 +57,6 @@ options: is a dictionary with the subnet name or ID (subnet) and the IP address to assign on the subnet (ip). If no IP is specified, one is automatically assigned from that subnet. - required: false - default: None interfaces: description: - List of subnets to attach to the router internal interface. Default @@ -75,13 +69,9 @@ options: User defined portip is often required when a multiple router need to be connected to a single subnet for which the default gateway has been already used. - - required: false - default: None availability_zone: description: - Ignored. Present for backwards compatibility - required: false requirements: ["shade"] ''' |