Docs4dev
Docs
ansible / 2.6 / modules / digital_ocean_sshkey_facts_module.html

digital_ocean_sshkey_facts - DigitalOcean SSH keys facts

New in version 2.5.

Synopsis

  • Fetch DigitalOcean SSH keys facts.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
oauth_token
DigitalOcean OAuth token.
There are several other environment variables which can be used to provide this value.
i.e., - 'DO_API_TOKEN', 'DO_API_KEY', 'DO_OAUTH_TOKEN' and 'OAUTH_TOKEN'

aliases: api_token
timeout Default:
30
The timeout in seconds used for polling DigitalOcean's API.
validate_certs
bool
    Choices:
  • no
  • yes ←
If set to no, the SSL certificates will not be validated.
This should only set to no used on personally controlled sites using self-signed certificates.

Notes

Note

  • Version 2 of DigitalOcean API is used.

Examples

- digital_ocean_sshkey_facts:
    oauth_token: "{{ my_do_key }}"

- set_fact:
    pubkey: "{{ item.public_key }}"
  with_items: "{{ ssh_keys|json_query(ssh_pubkey) }}"
  vars:
    ssh_pubkey: "[?name=='ansible_ctrl']"

- debug:
    msg: "{{ pubkey }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
data
dict
success and no resource constraint
List of SSH keys on DigitalOcean

Sample:
{'ssh_keys': [{'id': 512189, 'fingerprint': '3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa', 'public_key': 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example', 'name': 'My SSH Public Key'}], 'links': {}, 'meta': {'total': 1}}


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Patrick Marques (@pmarques)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/digital_ocean_sshkey_facts_module.html