Use newest documentation style for return value.

This commit is contained in:
David Shrewsbury 2015-06-29 15:55:15 -04:00 committed by Matt Clay
parent f1027ae6bc
commit 3cd81d2dd3

View file

@ -33,10 +33,6 @@ extends_documentation_fragment: openstack
version_added: "2.0" version_added: "2.0"
description: description:
- Add or Remove key pair from OpenStack - Add or Remove key pair from OpenStack
notes:
- The module returns a dictionary describing the keypair, with
keys including: id, name, public_key. A private_key entry may
also be included if a keypair was generated for you.
options: options:
name: name:
description: description:
@ -78,6 +74,26 @@ EXAMPLES = '''
name: ansible_key name: ansible_key
''' '''
RETURN = '''
id:
description: Unique UUID.
returned: success
type: string
name:
description: Name given to the keypair.
returned: success
type: string
public_key:
description: The public key value for the keypair.
returned: success
type: string
private_key:
description: The private key value for the keypair.
returned: Only when a keypair is generated for the user (e.g., when creating one
and a public key is not specified).
type: string
'''
def _system_state_change(module, keypair): def _system_state_change(module, keypair):
state = module.params['state'] state = module.params['state']