cs_ip_address.py: fix missing doc (#37109)

* cs_ip_address.py: fix missing doc

* update ignore.txt

(partly cherry picked from commit 67d8c8f5c6)
pull/37139/head
René Moser 7 years ago
parent 895d9abd7b
commit c054527d65

@ -1,23 +1,9 @@
#!/usr/bin/python #!/usr/bin/python
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
# #
# (c) 2015, Darren Worrall <darren@iweb.co.uk> # Copyright (c) 2015, Darren Worrall <darren@iweb.co.uk>
# (c) 2015, René Moser <mail@renemoser.net> # Copyright (c) 2015, René Moser <mail@renemoser.net>
# # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
ANSIBLE_METADATA = {'metadata_version': '1.1', ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['stableinterface'], 'status': ['stableinterface'],
@ -29,8 +15,8 @@ DOCUMENTATION = '''
module: cs_ip_address module: cs_ip_address
short_description: Manages public IP address associations on Apache CloudStack based clouds. short_description: Manages public IP address associations on Apache CloudStack based clouds.
description: description:
- Acquires and associates a public IP to an account or project. Due to API - Acquires and associates a public IP to an account or project.
limitations this is not an idempotent call, so be sure to only - Due to API limitations this is not an idempotent call, so be sure to only
conditionally call this when C(state=present) conditionally call this when C(state=present)
version_added: '2.0' version_added: '2.0'
author: author:
@ -41,58 +27,49 @@ options:
description: description:
- Public IP address. - Public IP address.
- Required if C(state=absent) - Required if C(state=absent)
required: false
default: null
domain: domain:
description: description:
- Domain the IP address is related to. - Domain the IP address is related to.
required: false
default: null
network: network:
description: description:
- Network the IP address is related to. - Network the IP address is related to.
required: false
default: null
vpc: vpc:
description: description:
- VPC the IP address is related to. - VPC the IP address is related to.
required: false
default: null
version_added: "2.2" version_added: "2.2"
account: account:
description: description:
- Account the IP address is related to. - Account the IP address is related to.
required: false
default: null
project: project:
description: description:
- Name of the project the IP address is related to. - Name of the project the IP address is related to.
required: false
default: null
zone: zone:
description: description:
- Name of the zone in which the IP address is in. - Name of the zone in which the IP address is in.
- If not set, default zone is used. - If not set, default zone is used.
required: false state:
default: null description:
- State of the IP address.
default: present
choices: [ present, absent ]
poll_async: poll_async:
description: description:
- Poll async jobs until job has finished. - Poll async jobs until job has finished.
required: false default: yes
default: true type: bool
extends_documentation_fragment: cloudstack extends_documentation_fragment: cloudstack
''' '''
EXAMPLES = ''' EXAMPLES = '''
# Associate an IP address conditonally - name: Associate an IP address conditonally
- local_action: local_action:
module: cs_ip_address module: cs_ip_address
network: My Network network: My Network
register: ip_address register: ip_address
when: instance.public_ip is undefined when: instance.public_ip is undefined
# Disassociate an IP address - name: Disassociate an IP address
- local_action: local_action:
module: cs_ip_address module: cs_ip_address
ip_address: 1.2.3.4 ip_address: 1.2.3.4
state: absent state: absent

@ -58,7 +58,6 @@ lib/ansible/modules/cloud/azure/azure_rm_virtualmachineimage_facts.py E323
lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork.py E322 lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork.py E322
lib/ansible/modules/cloud/centurylink/clc_alert_policy.py E317 lib/ansible/modules/cloud/centurylink/clc_alert_policy.py E317
lib/ansible/modules/cloud/centurylink/clc_firewall_policy.py E317 lib/ansible/modules/cloud/centurylink/clc_firewall_policy.py E317
lib/ansible/modules/cloud/cloudstack/cs_ip_address.py E322
lib/ansible/modules/cloud/cloudstack/cs_iso.py E323 lib/ansible/modules/cloud/cloudstack/cs_iso.py E323
lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule.py E322 lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule.py E322
lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule_member.py E322 lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule_member.py E322

Loading…
Cancel
Save