Модуль community.general.packet_sshkey – Создание/удаление SSH-ключа на хосте Packet

Примечание

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

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

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

Для использования в книге задач укажите: community.general.packet_sshkey.

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

Обзор

Создание/удаление SSH-ключа на хосте Packet.
Документация API находится по адресу https://www.packet.net/help/api/#page:ssh-keys,header:ssh-keys-ssh-keys-post.

Требования

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

packet-python

Параметры

Параметр	Комментарии
auth_token строка	Токен API Packet. Также можно указать его в переменной окружения `PACKET_API_TOKEN`.
fingerprint строка	Отпечаток ключа, который требуется удалить.
id строка	UUID ключа, который требуется удалить.
key строка	Строка открытого ключа ({тип} {ключ в base64} {описание}).
key_file путь	Файл с открытым ключом.
label псевдонимы: name строка	Метка для ключа. Если оставить пустой, она будет взята из строки ключа.
state строка	Указывает требуемое состояние целевого объекта. Варианты: `"present"` ← (по умолчанию) `"absent"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Может работать в режиме `check_mode` и возвращать прогнозируемое состояние изменений без изменения целевого объекта.
diff_mode	Поддержка: нет	Возвращает подробную информацию о том, что изменилось (или, возможно, требует изменения в `check_mode`), когда используется режим diff.

Примеры

# All the examples assume that you have your Packet API token in env var PACKET_API_TOKEN.
# You can also pass the api token in module param auth_token.

- name: Create sshkey from string
  hosts: localhost
  tasks:
    community.general.packet_sshkey:
      key: "{{ lookup('file', 'my_packet_sshkey.pub') }}"

- name: Create sshkey from file
  hosts: localhost
  tasks:
    community.general.packet_sshkey:
      label: key from file
      key_file: ~/ff.pub

- name: Remove sshkey by id
  hosts: localhost
  tasks:
    community.general.packet_sshkey:
      state: absent
      id: eef49903-7a09-4ca1-af67-4087c29ab5b6

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

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

Ключ	Описание
changed логический	True, если ssh-ключ был создан или удален. Возвращается: всегда Пример: `true`
sshkeys список / элементы=строка	Информация о ssh-ключах, которые были созданы/удалены. Возвращается: всегда Пример: [{"fingerprint": "5c:93:74:7c:ed:07:17:62:28:75:79:23:d6:08:93:46", "id": "41d61bd8-3342-428b-a09c-e67bdd18a9b7", "key": "ssh-dss AAAAB3NzaC1kc3MAAACBAIfNT5S0ncP4BBJBYNhNPxFF9lqVhfPeu6SM1LoCocxqDc1AT3zFRi8hjIf6TLZ2AA4FYbcAWxLMhiBxZRVldT9GdBXile78kAK5z3bKTwq152DCqpxwwbaTIggLFhsU8wrfBsPWnDuAxZ0h7mmrCjoLIE3CNLDA/NmV3iB8xMThAAAAFQCStcesSgR1adPORzBxTr7hug92LwAAAIBOProm3Gk+HWedLyE8IfofLaOeRnbBRHAOL4z0SexKkVOnQ/LGN/uDIIPGGBDYTvXgKZT+jbHeulRJ2jKgfSpGKN4JxFQ8uzVH492jEiiUJtT72Ss1dCV4PmyERVIw+f54itihV3z/t25dWgowhb0int8iC/OY3cGodlmYb3wdcQAAAIBuLbB45djZXzUkOTzzcRDIRfhaxo5WipbtEM2B1fuBt2gyrvksPpH/LK6xTjdIIb0CxPu4OCxwJG0aOz5kJoRnOWIXQGhH7VowrJhsqhIc8gN9ErbO5ea8b1L76MNcAotmBDeTUiPw01IJ8MdDxfmcsCslJKgoRKSmQpCwXQtN2g== tomk@hp2", "label": "mynewkey33"}]

Ключ

Описание

changed

логический

True, если ssh-ключ был создан или удален.

Возвращается: всегда

Пример: true

sshkeys

список / элементы=строка

Информация о ssh-ключах, которые были созданы/удалены.

Возвращается: всегда

Пример: [{"fingerprint": "5c:93:74:7c:ed:07:17:62:28:75:79:23:d6:08:93:46", "id": "41d61bd8-3342-428b-a09c-e67bdd18a9b7", "key": "ssh-dss AAAAB3NzaC1kc3MAAACBAIfNT5S0ncP4BBJBYNhNPxFF9lqVhfPeu6SM1LoCocxqDc1AT3zFRi8hjIf6TLZ2AA4FYbcAWxLMhiBxZRVldT9GdBXile78kAK5z3bKTwq152DCqpxwwbaTIggLFhsU8wrfBsPWnDuAxZ0h7mmrCjoLIE3CNLDA/NmV3iB8xMThAAAAFQCStcesSgR1adPORzBxTr7hug92LwAAAIBOProm3Gk+HWedLyE8IfofLaOeRnbBRHAOL4z0SexKkVOnQ/LGN/uDIIPGGBDYTvXgKZT+jbHeulRJ2jKgfSpGKN4JxFQ8uzVH492jEiiUJtT72Ss1dCV4PmyERVIw+f54itihV3z/t25dWgowhb0int8iC/OY3cGodlmYb3wdcQAAAIBuLbB45djZXzUkOTzzcRDIRfhaxo5WipbtEM2B1fuBt2gyrvksPpH/LK6xTjdIIb0CxPu4OCxwJG0aOz5kJoRnOWIXQGhH7VowrJhsqhIc8gN9ErbO5ea8b1L76MNcAotmBDeTUiPw01IJ8MdDxfmcsCslJKgoRKSmQpCwXQtN2g== tomk@hp2", "label": "mynewkey33"}]

Авторы

Tomas Karasek (@t0mk)

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

© 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/general/packet_sshkey_module.html