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

Примечание

Этот плагин входит в состав коллекции ngine_io.cloudstack (версия 1.1.0).

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

Для использования в книге задач укажите: ngine_io.cloudstack.cs_sshkeypair.

В версии 0.1.0: из ngine_io.cloudstack

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

Описание

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

Требования

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

python >= 2.6
cs >= 0.9.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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, см. также примечания.
api_verify_ssl_cert строка		Файл сертификата CA. Если не указан, используется переменная среды `CLOUDSTACK_VERIFY`. В качестве последнего варианта, значение берётся из файла конфигурации ini, см. также примечания. Значение по умолчанию `null`, если не указано.
domain строка		Домен, к которому относится открытый ключ.
name строка / обязательно		Имя открытого ключа.
project строка		Имя проекта, в котором должен быть зарегистрирован открытый ключ.
public_key строка		Строка открытого ключа.
state строка	Варианты: present ← absent	Состояние открытого ключа.

Примечания

Примечание

Ansible использует метод конфигурации библиотеки cs если учетные данные не предоставлены в аргументах api_url, api_key, api_secret. Конфигурация считывается из нескольких мест в указанном ниже порядке. Переменные среды CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET и CLOUDSTACK_METHOD. CLOUDSTACK_TIMEOUT переменная окружения, указывающая на файл CLOUDSTACK_CONFIG. Файл cloudstack.ini в текущей рабочей директории. Файл .cloudstack.ini в домашней директории пользователя. Допускается указание нескольких учетных данных и точек входа с использованием разделов ini в cloudstack.ini. Используйте аргумент api_region для выбора имени раздела, по умолчанию это cloudstack. Подробнее см. https://github.com/exoscale/cs.
Подробное руководство по модулям 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 строка	success	Отпечаток открытого ключа SSH. Пример: 86:5e:a3:e8:bd:95:7b:07:7c:c2:5c:f7:ad:8b:09:28
id строка	success	UUID открытого ключа SSH. Пример: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
name строка	success	Имя открытого ключа SSH. Пример: linus@example.com
private_key строка	changed	Закрытый ключ сгенерированной пары ключей SSH. Пример: -----BEGIN RSA PRIVATE KEY----- MII...8tO -----END RSA PRIVATE KEY-----

Авторы

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.10/collections/ngine_io/cloudstack/cs_sshkeypair_module.html