Модуль community.hrobot.ssh_key – добавление, удаление или обновление ключа SSH

Примечание

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

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

Чтобы установить коллекцию, используйте: ansible-galaxy collection install community.hrobot.

Чтобы использовать её в плейбуке, укажите: community.hrobot.ssh_key.

Добавлено в community.hrobot 1.2.0

Краткое описание
Параметры
Атрибуты
См. также
Примеры
Возвращаемые значения

Краткое описание

Добавляет, удаляет или обновляет ключ SSH, хранящийся в Hetzner Robot.

Параметры

Параметр	Комментарии
fingerprint string	Отпечаток MD5 открытого ключа SSH, который нужно удалить. Если `state=absent`, требуется указать `public_key` или `fingerprint`.
hetzner_password string / обязательный	Пароль пользователя веб-службы Robot.
hetzner_user string / обязательный	Имя пользователя веб-службы Robot.
name string	Имя открытого ключа. Обязателен, если `state=present`, и игнорируется, если `state=absent`.
public_key string	Данные открытого ключа в формате OpenSSH. Пример: `ssh-rsa AAAAB3NzaC1yc+..`. Если `state=absent`, требуется указать `public_key` или `fingerprint`. Обязателен, если `state=present`.
rate_limit_retry_timeout integer добавлено в community.hrobot 2.1.0	Время ожидания (в секундах) при получении ошибок превышения ограничения частоты запросов. Установите значение `0`, чтобы отключить повторные попытки. Установите отрицательное значение, например `-1`, чтобы повторять попытки бесконечно. По умолчанию: `-1`
state string / обязательный	Определяет, должен ли открытый ключ SSH присутствовать или отсутствовать. `present` гарантирует наличие ключа SSH и при необходимости обновляет имена существующих открытых ключей SSH. `absent` гарантирует отсутствие ключа SSH. Для поиска ключа используются его отпечаток или данные открытого ключа. Варианты: `"present"` `"absent"`

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.hrobot.robot добавлено в community.hrobot 1.6.0	Используйте `group/community.hrobot.robot` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: полная	Модуль может работать в режиме `check_mode` и возвращать прогноз изменения состояния без изменения целевого объекта.
diff_mode	Поддержка: нет	В режиме сравнения будут возвращены сведения о внесённых изменениях (или изменениях, которые, возможно, необходимо внести в `check_mode`).
idempotent	Поддержка: полная	При повторном запуске с теми же аргументами вне режима проверки модуль указывает, что изменений нет. Предполагается, что система, которой управляет модуль или к которой он обращается, не изменилась существенным образом.

См. также

community.hrobot.ssh_key_info: Получение сведений о ключах SSH.

Примеры

---
- name: Add an SSH key
  community.hrobot.ssh_key:
    hetzner_user: foo
    hetzner_password: bar
    state: present
    name: newKey
    public_key: ssh-rsa AAAAB3NzaC1yc+...

- name: Remove a SSH key by fingerprint
  community.hrobot.ssh_key:
    hetzner_user: foo
    hetzner_password: bar
    state: absent
    fingerprint: cb:8b:ef:a7:fe:04:87:3f:e5:55:cd:12:e3:e8:9f:99

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

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

Ключ	Описание
fingerprint string	Отпечаток MD5 ключа. Это значение используется для ссылки на открытый ключ SSH, например в модуле community.hrobot.boot. Возвращается: при успешном выполнении Пример: `"cb:8b:ef:a7:fe:04:87:3f:e5:55:cd:12:e3:e8:9f:99"`

Авторы

Felix Fontein (@felixfontein)

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

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