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

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

Описание

Создание, регистрация и удаление ключей 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	Состояние публичного ключа.

Примечания

Примечание

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.
Этот модуль поддерживает режим проверки.

Примеры

- name: 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 }}'

- name: remove a public key by its name
  cs_sshkeypair:
    name: linus@example.com
    state: absent
  delegate_to: localhost

- name: 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.9/modules/cs_sshkeypair_module.html