Модуль community.digitalocean.digital_ocean_sshkey — Управление ключами SSH DigitalOcean

Примечание

Этот модуль входит в коллекцию community.digitalocean (версия 1.27.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.digitalocean. Для использования этого модуля потребуются дополнительные зависимости. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: community.digitalocean.digital_ocean_sshkey.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Создание/удаление ключей SSH DigitalOcean.

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.6

Параметры

Параметр	Комментарии
baseurl строка	Базовый URL API DigitalOcean. По умолчанию: `"https://api.digitalocean.com/v2"`
fingerprint алиасы: id строка	Уникальный идентификатор ключа SSH для удаления ключа.
name строка	Имя ключа SSH.
oauth_token алиасы: api_token строка	Токен OAuth DigitalOcean. Можно использовать переменные среды: например, - `DO_API_TOKEN`, `DO_API_KEY`, `DO_OAUTH_TOKEN` и `OAUTH_TOKEN`.
ssh_pub_key строка	Открытый ключ SSH для добавления.
state строка	Определяет желаемое состояние целевого объекта. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout целое число	Таймаут в секундах для опроса API DigitalOcean. По умолчанию: `30`
validate_certs булево	Если установлено в `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с самоподписанными сертификатами. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используется версия 2 API DigitalOcean.

Примеры

- 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"

Возвращаемые значения

Общие возвращаемые значения описаны здесь. Следующие поля уникальны для этого модуля:

Ключ	Описание
data словарь	Присутствует только при `state=present` Возвращается: при `state=present` Пример: `{"ssh_key": {"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"}}`

Ключ

Описание

data

словарь

Присутствует только при state=present

Возвращается: при state=present

Пример: {"ssh_key": {"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"}}

Авторы

Patrick Marques (@pmarques)

Ссылки на коллекцию

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