hcloud_ssh_key – Создание и управление ключами SSH на Hetzner Cloud
Новая версия с 2.8.
Обзор
- Создание, обновление и управление ключами 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 или имя ключа.
|
|
|
id
целое число
|
ID ключа SSH Hetzner Cloud для управления.
Требуется только если не указано имя ключа.
|
|
|
labels
словарь
|
Пользовательские метки (пары ключ-значение)
|
|
|
name
строка
|
Имя ключа SSH Hetzner Cloud для управления.
Требуется только если не указан ID ключа или ключ не существует.
|
|
|
public_key
строка
|
Открытый ключ для добавления.
Требуется, если ключ не существует.
|
|
|
state
строка
|
|
Состояние ключа 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
целое число
|
Всегда |
ID ключа ssh_key
Пример:
12345
|
|
|
labels
словарь
|
Всегда |
Пользовательские метки (пары ключ-значение)
Пример:
{'key': 'value', 'mylabel': 123}
|
|
|
name
строка
|
Всегда |
Имя ключа ssh_key
Пример:
my-ssh-key
|
|
|
public_key
строка
|
Всегда |
Открытый ключ ssh_key
Пример:
ssh-rsa AAAjjk76kgf...Xt
|
|
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.8/modules/hcloud_ssh_key_module.html
