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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 строка	Строка открытого ключа (`{type} {base64 encoded key} {description}`).
key_file путь	Файл с открытым ключом.
label псевдонимы: name строка	Метка ключа. Если оставить поле пустым, метка будет получена из строки ключа.
state строка	Задает требуемое состояние целевого объекта. Варианты: `"present"` ← (по умолчанию) `"absent"`

Атрибуты

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

Примеры

# 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

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

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

Ключ	Описание
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 AAAAB3NzaC1kc3MAAACBA ... MdDxfmcsCslJKgoRKSmQpCwXQtN2g== user@server", "label": "mynewkey33"}]`

Авторы

Tomas Karasek (@t0mk)

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

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