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

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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_token строка / обязательно	Токен API для Hetzner Cloud. Вы также можете установить этот параметр, используя переменную среды `HCLOUD_TOKEN`.
fingerprint строка	Отпечаток ключа ssh_key Hetzner Cloud для управления. Требуется только если не задан id или name ключа ssh.
id целое число	Идентификатор ключа ssh_key Hetzner Cloud для управления. Требуется только если не задано name ключа ssh.
labels словарь	Пользовательские метки (пары ключ-значение)
name строка	Имя ключа ssh_key Hetzner Cloud для управления. Требуется только если не задан id ключа ssh или ключ ssh не существует.
public_key строка	Открытый ключ для добавления. Требуется, если ключ ssh не существует.
state строка	Состояние ключа ssh. Варианты: `"absent"` `"present"` ← (по умолчанию)

См. также

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

Примеры

- 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 целое число	Идентификатор ключа 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/hetzner/hcloud/ssh_key_module.html