community.digitalocean.digital_ocean_sshkey module – Manage DigitalOcean SSH keys
Note
This module is part of the community.digitalocean collection (version 1.22.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.digitalocean
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.digitalocean.digital_ocean_sshkey
.
Synopsis
Create/delete DigitalOcean SSH keys.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
Parameters
Parameter |
Comments |
---|---|
DigitalOcean API base url. Default: |
|
This is a unique identifier for the SSH key used to delete a key |
|
The name for the SSH key |
|
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’ |
|
The Public SSH key to add. |
|
Indicate desired state of the target. Choices:
|
|
The timeout in seconds used for polling DigitalOcean’s API. Default: |
|
If set to This should only set to Choices:
|
Notes
Note
Version 2 of DigitalOcean API is used.
Examples
- name: "Create ssh key"
community.digitalocean.digital_ocean_sshkey:
oauth_token: "{{ oauth_token }}"
name: "My SSH Public Key"
ssh_pub_key: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example"
state: present
register: result
- name: "Delete ssh key"
community.digitalocean.digital_ocean_sshkey:
oauth_token: "{{ oauth_token }}"
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, the following are the fields unique to this module:
Key |
Description |
---|---|
This is only present when Returned: when Sample: |