/ home / community / community.general / 0.2.1 / module / digital_ocean_sshkey_info

community.general.digital_ocean_sshkey_info (0.2.1) — module

Gather information about DigitalOcean SSH keys

Authors: Patrick Marques (@pmarques)

Install collection

Install with ansible-galaxy collection install community.general:==0.2.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.2.1

Description

This module can be used to gather information about DigitalOcean SSH keys.

This module replaces the C(digital_ocean_sshkey_facts) module.

Requirements

python >= 2.6

Usage examples

Scanned by Steampunk Spotter

- name: Gather information about DigitalOcean SSH keys
  digital_ocean_sshkey_info:
    oauth_token: "{{ my_do_key }}"
  register: ssh_keys

Scanned by Steampunk Spotter

- name: Set facts based on the gathered information
  set_fact:
    pubkey: "{{ item.public_key }}"
  loop: "{{ ssh_keys.data|json_query(ssh_pubkey) }}"
  vars:
    ssh_pubkey: "[?name=='ansible_ctrl']"

Scanned by Steampunk Spotter

- name: Print SSH public key
  debug:
    msg: "{{ pubkey }}"

Inputs

    
timeout:
    default: 30
    description:
    - The timeout in seconds used for polling DigitalOcean's API.
    type: int

oauth_token:
    aliases:
    - api_token
    description:
    - 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'
    type: str

validate_certs:
    default: true
    description:
    - If set to C(no), the SSL certificates will not be validated.
    - This should only set to C(no) used on personally controlled sites using self-signed
      certificates.
    type: bool

Outputs

data:
  description: List of SSH keys on DigitalOcean
  returned: success and no resource constraint
  sample:
  - fingerprint: 3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa
    id: 512189
    name: My SSH Public Key
    public_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V
      example
  type: dict