cs_sshkeypair – Управляет ключами SSH в облаках на основе Apache CloudStack.

Новая версия с 2.0.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Создаёт, регистрирует и удаляет ключи SSH.
Если ключ не был найден, а открытый ключ не был предоставлен, будет создана новая пара SSH-ключей (открытый и закрытый), и закрытый ключ будет возвращён.

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account -		Аккаунт, к которому относится открытый ключ.
api_http_method -	Варианты: get post	HTTP-метод, используемый для запроса к API-точке входа. Если не указано, используется переменная среды `CLOUDSTACK_METHOD`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. Значение по умолчанию - `get`, если не указано.
api_key -		API-ключ CloudStack API. Если не указано, используется переменная среды `CLOUDSTACK_KEY`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
api_region -	Значение по умолчанию: "cloudstack"	Имя раздела ini в файле `cloustack.ini`. Если не указано, используется переменная среды `CLOUDSTACK_REGION`.
api_secret -		Секретный ключ CloudStack API. Если не указано, используется переменная среды `CLOUDSTACK_SECRET`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
api_timeout -		Таймаут HTTP в секундах. Если не указано, используется переменная среды `CLOUDSTACK_TIMEOUT`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. Значение по умолчанию - 10 секунд, если не указано.
api_url -		URL CloudStack API, например, https://cloud.example.com/client/api. Если не указано, используется переменная среды `CLOUDSTACK_ENDPOINT`. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
domain -		Домен, к которому относится открытый ключ.
name - / обязательно		Имя открытого ключа.
project -		Имя проекта, в котором должен быть зарегистрирован открытый ключ.
public_key -		Строка открытого ключа.
state -	Варианты: present ← absent	Состояние открытого ключа.

Примечания

Примечание

Если учетные данные не предоставлены в аргументах api_url, api_key, api_secret, Ansible использует метод конфигурации библиотеки cs . Конфигурация считывается из нескольких источников в указанном порядке: 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 доступно в Руководстве по облаку CloudStack.
Этот модуль поддерживает режим проверки.

Примеры

# 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-----

Статус

Для этого модуля гарантируются отсутствие обратной совместимости в будущем. [stableinterface]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

René Moser (@resmo)

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/cs_sshkeypair_module.html