Модуль ngine_io.cloudstack.cs_sshkeypair – Управление ключами SSH в облаках на основе Apache CloudStack.
Примечание
Этот модуль является частью коллекции ngine_io.cloudstack (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install ngine_io.cloudstack. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.
Чтобы использовать его в playbook, укажите: ngine_io.cloudstack.cs_sshkeypair.
Новое в ngine_io.cloudstack 0.1.0
Краткое описание
- Создание, регистрация и удаление ключей SSH.
- Если ключ не найден и открытый ключ не предоставлен, будет создана новая пара закрытых/открытых ключей SSH, и закрытый ключ будет возвращен.
Требования
Ниже указаны требования, необходимые на хосте, который выполняет этот модуль.
- python >= 2.6
- cs >= 0.9.0
Параметры
Параметр | Комментарии |
|---|---|
account строка | Учетная запись, с которой связан открытый ключ. |
api_http_method строка | HTTP-метод, используемый для запроса конечной точки API. Если не указано, учитывается переменная среды Варианты:
|
api_key строка / обязательно | API-ключ API CloudStack. Если не указано, учитывается переменная среды |
api_secret строка / обязательно | Секретный ключ API CloudStack. Если не указано, учитывается переменная среды |
api_timeout целое число | Таймаут HTTP в секундах. Если не указано, учитывается переменная среды По умолчанию: |
api_url строка / обязательно | URL API CloudStack, например, https://cloud.example.com/client/api. Если не указано, учитывается переменная среды |
api_verify_ssl_cert строка | Проверить файл сертификата центра сертификации. Если не указано, учитывается переменная среды |
domain строка | Домен, с которым связан открытый ключ. |
name строка / обязательно | Имя открытого ключа. |
project строка | Имя проекта, в котором будет зарегистрирован открытый ключ. |
public_key строка | Строка открытого ключа. |
state строка | Состояние открытого ключа. Варианты:
|
validate_certs булево добавлено в ngine_io.cloudstack 2.4.0 | Если Если не указано, учитывается переменная среды Это следует использовать только на лично контролируемых сайтах, использующих самоподписанные сертификаты. Варианты:
|
Примечания
Примечание
- Подробное руководство по модулям 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 строка | Отпечаток SSH-открытого ключа. Возвращается: success Пример: |
id строка | UUID SSH-открытого ключа. Возвращается: success Пример: |
name строка | Имя SSH-открытого ключа. Возвращается: success Пример: |
private_key строка | Закрытый ключ сгенерированной пары SSH-ключей. Возвращается: changed Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ngine_io/cloudstack/cs_sshkeypair_module.html