ngine_io.cloudstack.cs_sshkeypair – Управляет ключами SSH на облаках на основе Apache CloudStack.
Примечание
Этот плагин является частью коллекции ngine_io.cloudstack (версия 2.0.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.cloudstack.
Для использования в книге задач укажите: ngine_io.cloudstack.cs_sshkeypair.
Новое в версии 0.1.0: of ngine_io.cloudstack
Обзор
- Создание, регистрация и удаление ключей SSH.
- Если ключ не был найден, а открытый ключ не был предоставлен, будет создана новая пара ключей SSH (приватный/публичный), и приватный ключ будет возвращен.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- cs >= 0.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account строка | Аккаунт, к которому относится открытый ключ. | |
| api_http_method строка |
| Метод HTTP, используемый для запроса к API-точке. Если не указан, используется значение переменной среды CLOUDSTACK_METHOD. |
| api_key строка / обязательно | Ключ API CloudStack API. Если не указан, используется значение переменной среды CLOUDSTACK_KEY. | |
| api_secret строка / обязательно | Секретный ключ CloudStack API. Если не указан, используется значение переменной среды CLOUDSTACK_SECRET. | |
| api_timeout целое число | По умолчанию: 10 | Таймаут HTTP в секундах. Если не указан, используется значение переменной среды CLOUDSTACK_TIMEOUT. |
| api_url строка / обязательно | URL CloudStack API, например https://cloud.example.com/client/api. Если не указан, используется значение переменной среды CLOUDSTACK_ENDPOINT. | |
| api_verify_ssl_cert строка | Проверка сертификата CA. Если не указан, используется значение переменной среды CLOUDSTACK_VERIFY. | |
| domain строка | Домен, к которому относится открытый ключ. | |
| name строка / обязательно | Имя открытого ключа. | |
| project строка | Имя проекта, в котором будет зарегистрирован открытый ключ. | |
| public_key строка | Строковое представление открытого ключа. | |
| state строка |
| Состояние открытого ключа. |
Примечания
Примечание
- Подробное руководство по модулям cloudstack можно найти в Руководстве по облакам CloudStack.
- Этот модуль поддерживает режим проверки.
Примеры
- name: create a new private / public key pair
ngine_io.cloudstack.cs_sshkeypair:
name: linus@example.com
register: key
- debug:
msg: 'Private key is {{ key.private_key }}'
- name: remove a public key by its name
ngine_io.cloudstack.cs_sshkeypair:
name: linus@example.com
state: absent
- name: register your existing local public key
ngine_io.cloudstack.cs_sshkeypair:
name: linus@example.com
public_key: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| fingerprint строка | успех | Отпечаток открытого ключа SSH. Пример: 86:5e:a3:e8:bd:95:7b:07:7c:c2:5c:f7:ad:8b:09:28 |
| id строка | успех | UUID открытого ключа SSH. Пример: a6f7a5fc-43f8-11e5-a151-feff819cdc9f |
| name строка | успех | Имя открытого ключа SSH. Пример: linus@example.com |
| private_key строка | изменилось | Приватный ключ сгенерированной пары ключей SSH. Пример: -----BEGIN RSA PRIVATE KEY----- MII...8tO -----END RSA PRIVATE KEY----- |
Авторы
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/cloudstack/cs_sshkeypair_module.html