Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин входит в состав коллекции hetzner.hcloud (версия 1.2.1).

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

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

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

Обзор

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

Требования

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

  • hcloud-python >= 1.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
api_token
строка / обязательно
Токен API для Hetzner Cloud.
endpoint
строка
Значение по умолчанию:
"https://api.hetzner.cloud/v1"
Адрес API-интерфейса Hetzner Cloud.
fingerprint
строка
Отпечаток ключа SSH Hetzner Cloud для управления.
Требуется только если не указан id или name ключа SSH.
id
целое число
Идентификатор ключа SSH Hetzner Cloud для управления.
Требуется только если не указано name ключа SSH.
labels
словарь
Пользовательские метки (пары ключ-значение)
name
строка
Имя ключа SSH Hetzner Cloud для управления.
Требуется только если не указан id ключа SSH или ключ SSH не существует.
public_key
строка
Открытый ключ для добавления.
Требуется, если ключ SSH не существует.
state
строка
    Варианты:
  • absent
  • present ←
Состояние ключа SSH.

См. также

См. также

Документация по API Hetzner Cloud

Полная справка по API Hetzner Cloud.

Примеры

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

- name: Create a ssh_key with labels
  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)
  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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/hetzner/hcloud/hcloud_ssh_key_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API