mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-23 05:10:22 -07:00
ec2_key: document return values (#32813)
This commit is contained in:
parent
6957339fce
commit
e23928cb41
1 changed files with 31 additions and 0 deletions
|
@ -102,6 +102,37 @@ EXAMPLES = '''
|
||||||
name: example
|
name: example
|
||||||
state: absent
|
state: absent
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
RETURN = '''
|
||||||
|
changed:
|
||||||
|
description: whether a keypair was created/deleted
|
||||||
|
returned: always
|
||||||
|
type: bool
|
||||||
|
sample: true
|
||||||
|
key:
|
||||||
|
description: details of the keypair (this is set to null when state is absent)
|
||||||
|
returned: always
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
fingerprint:
|
||||||
|
description: fingerprint of the key
|
||||||
|
returned: when state is present
|
||||||
|
type: string
|
||||||
|
sample: 'b0:22:49:61:d9:44:9d:0c:7e:ac:8a:32:93:21:6c:e8:fb:59:62:43'
|
||||||
|
name:
|
||||||
|
description: name of the keypair
|
||||||
|
returned: when state is present
|
||||||
|
type: string
|
||||||
|
sample: my_keypair
|
||||||
|
private_key:
|
||||||
|
description: private key of a newly created keypair
|
||||||
|
returned: when a new keypair is created by AWS (key_material is not provided)
|
||||||
|
type: string
|
||||||
|
sample: '-----BEGIN RSA PRIVATE KEY-----
|
||||||
|
MIIEowIBAAKC...
|
||||||
|
-----END RSA PRIVATE KEY-----'
|
||||||
|
'''
|
||||||
|
|
||||||
import random
|
import random
|
||||||
import string
|
import string
|
||||||
import time
|
import time
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue