hetzner.hcloud.ssh_key module – создание и управление SSH-ключами в Hetzner Cloud.

Примечание

Этот модуль входит в коллекцию hetzner.hcloud (версия 6.9.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: hetzner.hcloud.ssh_key.

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

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

Создание, обновление и управление SSH-ключами в Hetzner Cloud.

Псевдонимы: hcloud_ssh_key

Требования

Следующие зависимости должны быть установлены на узле, который выполняет этот модуль.

python-dateutil >= 2.7.5
requests >=2.20

Параметры

Параметр	Комментарии
api_endpoint псевдонимы: endpoint строка	Конечная точка API Hetzner Cloud. Вы также можете задать этот параметр с помощью переменной окружения `HCLOUD_ENDPOINT`. По умолчанию: `"https://api.hetzner.cloud/v1"`
api_endpoint_hetzner строка	Конечная точка API Hetzner. Вы также можете задать этот параметр с помощью переменной окружения `HETZNER_ENDPOINT`. По умолчанию: `"https://api.hetzner.com/v1"`
api_token строка / обязательный	Токен API Hetzner Cloud. Вы также можете задать этот параметр с помощью переменной окружения `HCLOUD_TOKEN`.
fingerprint строка	Отпечаток SSH-ключа Hetzner Cloud, которым нужно управлять. Требуется, только если не указаны id или name ssh_key.
force логический	Повторно создать SSH-ключ, если открытый ключ не совпадает с ключом в API. Варианты: `false` ← (по умолчанию) `true`
id целое число	ID SSH-ключа Hetzner Cloud, которым нужно управлять. Требуется, только если не указано name ssh_key.
labels словарь	Метки, определяемые пользователем (пары «ключ-значение»)
name строка	Имя SSH-ключа Hetzner Cloud, которым нужно управлять. Требуется, только если не указан id ssh_key или если ssh_key не существует.
public_key строка	Добавляемый открытый ключ. Обязательный параметр, если ssh_key не существует.
state строка	Состояние ssh_key. Варианты: `"absent"` `"present"` ← (по умолчанию)

См. также

Документация по API Hetzner: Полный справочник по API Hetzner.

Примеры

- name: Create a basic ssh_key
  hetzner.hcloud.ssh_key:
    name: my-ssh_key
    public_key: ssh-rsa AAAjjk76kgf...Xt
    state: present

- name: Create a ssh_key with labels
  hetzner.hcloud.ssh_key:
    name: my-ssh_key
    public_key: ssh-rsa AAAjjk76kgf...Xt
    labels:
      key: value
      mylabel: 123
    state: present

- name: Ensure the ssh_key is absent (remove if needed)
  hetzner.hcloud.ssh_key:
    name: my-ssh_key
    state: absent

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

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

Ключ	Описание
hcloud_ssh_key словарь	Экземпляр ssh_key Возвращается: Всегда
fingerprint строка	Отпечаток ssh_key Возвращается: Всегда Пример: `"b7:2f:30:a0:2f:6c:58:6c:21:04:58:61:ba:06:3b:2f"`
id целое число	ID ssh_key Возвращается: Всегда Пример: `12345`
labels словарь	Метки, определяемые пользователем (пары «ключ-значение») Возвращается: Всегда Пример: `{"key": "value", "mylabel": 123}`
name строка	Имя ssh_key Возвращается: Всегда Пример: `"my-ssh-key"`
public_key строка	Открытый ключ ssh_key Возвращается: Всегда Пример: `"ssh-rsa AAAjjk76kgf...Xt"`

Авторы

Lukas Kaemmerling (@LKaemmerling)

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

© 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/hetzner/hcloud/ssh_key_module.html