cs_sshkeypair - Управляет ключами SSH на облаках Apache CloudStack.
Новая версия с 2.0.
- Обзор
- Требования (для хоста, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Создаёт, регистрирует и удаляет ключи SSH.
- Если ключ не был найден и не был предоставлен открытый ключ, будет создана новая пара частных/открытых ключей SSH, а частный ключ будет возвращён.
Требования (для хоста, на котором выполняется модуль)
- python >= 2.6
- cs >= 0.6.10
Параметры
| параметр | обязателен | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| account | нет | Аккаунт, к которому относится открытый ключ. | ||
| api_http_method | нет | get |
| Используемый HTTP-метод. |
| api_key | нет | Ключ API CloudStack API. | ||
| api_region | нет | cloudstack | Имя раздела ini в файле cloustack.ini. | |
| api_secret | нет | Секретный ключ CloudStack API. | ||
| api_timeout | нет | 10 | Таймаут HTTP. | |
| api_url | нет | URL CloudStack API, например, https://cloud.example.com/client/api. | ||
| domain | нет | Домен, к которому относится открытый ключ. | ||
| name | да | Имя открытого ключа. | ||
| project | нет | Имя проекта, в котором должен быть зарегистрирован открытый ключ. | ||
| public_key | нет | Строка открытого ключа. | ||
| state | нет | present |
| Состояние открытого ключа. |
Примеры
# create a new private / public key pair:
- cs_sshkeypair:
name: linus@example.com
delegate_to: localhost
register: key
- debug:
msg: 'Private key is {{ key.private_key }}'
# remove a public key by its name:
- cs_sshkeypair:
name: linus@example.com
state: absent
delegate_to: localhost
# register your existing local public key:
- cs_sshkeypair:
name: linus@example.com
public_key: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| 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----- |
Примечания
Примечание
- Ansible использует метод конфигурации библиотеки
csесли учетные данные не предоставлены аргументамиapi_url,api_key,api_secret. Конфигурация считывается из нескольких источников в следующем порядке. - ФайлыCLOUDSTACK_ENDPOINT,CLOUDSTACK_KEY,CLOUDSTACK_SECRETиCLOUDSTACK_METHOD. Переменные окруженияCLOUDSTACK_TIMEOUT. - Переменная окруженияCLOUDSTACK_CONFIGуказывающая на файл.ini, - Файлcloudstack.iniв текущей рабочей директории. - Файл.cloudstack.iniв домашней директории пользователя. Допускается указание нескольких учетных данных и конечных точек, используя разделы ini вcloudstack.ini. Используйте аргументapi_regionдля выбора имени раздела, по умолчанию используется разделcloudstack. Для получения дополнительной информации см. https://github.com/exoscale/cs. - Подробное руководство по модулям cloudstack можно найти на http://docs.ansible.com/ansible/guide_cloudstack.html
- Этот модуль поддерживает режим проверки.
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будут вноситься несовместимые изменения в интерфейс.
Если вы заинтересованы в разработке модулей, ознакомьтесь с Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/cs_sshkeypair_module.html