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

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

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

Обзор

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

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

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

Примечания

Примечание

Ansible использует метод конфигурации библиотеки cs если учетные данные не предоставлены параметрами api_url, api_key, api_secret. Конфигурация считывается из нескольких мест в следующем порядке. CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET и CLOUDSTACK_METHOD переменные окружения. CLOUDSTACK_TIMEOUT переменная окружения, указывающая на файл .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 строка	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-----

Статус

Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будет вноситься обратной несовместимой модификации интерфейса.

Автор

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