W3cubDocs

/Ansible

digital_ocean_sshkey - Manage DigitalOcean SSH keys

New in version 2.4.

Synopsis

  • Create/delete DigitalOcean SSH keys.

Requirements (on host that executes module)

  • python >= 2.6

Options

parameter required default choices comments
fingerprint
(added in 2.4)
 no None
This is a unique identifier for the SSH key used to delete a key
name
 no None
The name for the SSH key
oauth_token
(added in 2.4)
 yes
DigitalOcean OAuth token.
ssh_pub_key
 no None
The Public SSH key to add.
state
 no present
  • present
  • absent
Indicate desired state of the target.

Examples

- name: "Create ssh key"
  digital_ocean_sshkey:
    name: "My SSH Public Key"
    public_key: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example"
  register: result

- name: "Delete ssh key"
  digital_ocean_sshkey:
    state: "absent"
    fingerprint: "3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa"

Return Values

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

name description returned type sample
data
This is only present when state=present
when C(state=present) dict {'ssh_key': {'public_key': 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example', 'fingerprint': '3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa', 'id': 512189, 'name': 'My SSH Public Key'}}

Notes

Note

  • Version 2 of DigitalOcean API is used.

Status

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

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/digital_ocean_sshkey_module.html