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

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.hrobot.

Для использования в playbook укажите: community.hrobot.ssh_key.

Новое в community.hrobot 1.2.0

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

Описание

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

Параметры

Параметр	Комментарии
fingerprint строка	MD5 отпечаток открытого ключа SSH для удаления. Требуется один из `public_key` и `fingerprint`, если `state=absent`.
hetzner_password строка / обязательно	Пароль пользователя веб-сервиса Robot.
hetzner_user строка / обязательно	Имя пользователя пользователя веб-сервиса Robot.
name строка	Имя открытого ключа. Требуется, если `state=present`, и игнорируется, если `state=absent`.
public_key строка	Данные открытого ключа в формате OpenSSH. Пример: `ssh-rsa AAAAB3NzaC1yc+...` Требуется один из `public_key` и `fingerprint`, если `state=absent`. Требуется, если `state=present`.
state строка / обязательно	Указывает, нужно ли гарантировать наличие или отсутствие открытого ключа 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`), когда используется режим сравнения.

См. также

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 строка	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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/hrobot/ssh_key_module.html