mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Document return values of ec2_eip (#32018)
- added RETURN value for ec2_eip - removed note about what is returned - removed a duplicate example
This commit is contained in:
parent
78347e12a3
commit
61554143d0
1 changed files with 13 additions and 6 deletions
|
@ -76,8 +76,6 @@ extends_documentation_fragment:
|
|||
- ec2
|
||||
author: "Rick Mendes (@rickmendes) <rmendes@illumina.com>"
|
||||
notes:
|
||||
- This module will return C(public_ip) on success, which will contain the
|
||||
public IP address associated with the device.
|
||||
- There may be a delay between the time the EIP is assigned and when
|
||||
the cloud instance is reachable via the new address. Use wait_for and
|
||||
pause to delay further playbook execution until the instance is reachable,
|
||||
|
@ -131,10 +129,6 @@ EXAMPLES = '''
|
|||
debug:
|
||||
msg: "Allocated IP is {{ eip.public_ip }}"
|
||||
|
||||
- name: another way of allocating an elastic IP without associating it to anything
|
||||
ec2_eip:
|
||||
state: 'present'
|
||||
|
||||
- name: provision new instances with ec2
|
||||
ec2:
|
||||
keypair: mykey
|
||||
|
@ -161,6 +155,19 @@ EXAMPLES = '''
|
|||
msg: "Allocated IP inside a VPC is {{ eip.public_ip }}"
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
allocation_id:
|
||||
description: allocation_id of the elastic ip
|
||||
returned: on success
|
||||
type: string
|
||||
sample: eipalloc-51aa3a6c
|
||||
public_ip:
|
||||
description: an elastic ip address
|
||||
returned: on success
|
||||
type: string
|
||||
sample: 52.88.159.209
|
||||
'''
|
||||
|
||||
try:
|
||||
import boto.exception
|
||||
except ImportError:
|
||||
|
|
Loading…
Reference in a new issue