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"	Имя раздела в файле конфигурации `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	Состояние открытого ключа.

Примечания

Примечание

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 можно найти в Руководстве по облакам 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, что означает, что разработчики гарантируют отсутствие изменений интерфейса, несовместимых со старыми версиями.

Техническое обслуживание

Этот модуль помечен как community, что означает, что его поддерживает сообщество Ansible. Дополнительная информация см. в Поддержка и техническое обслуживание модулей.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

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.6/modules/cs_sshkeypair_module.html