Модуль ngine_io.cloudstack.ssh_key – Управляет SSH-ключами в облаках на базе Apache CloudStack.

Примечание

Этот модуль входит в коллекцию ngine_io.cloudstack (версия 3.0.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install ngine_io.cloudstack. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: ngine_io.cloudstack.ssh_key.

Добавлен в ngine_io.cloudstack 0.1.0

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

Краткое описание

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

Псевдонимы: cs_sshkeypair

Требования

На узле, выполняющем этот модуль, необходимы следующие компоненты.

python >= 2.6
cs >= 0.9.0

Параметры

Параметр	Описание
account string	Учётная запись, к которой относится открытый ключ.
api_http_method string	HTTP-метод, используемый для запроса к конечной точке API. Если значение не задано, используется переменная окружения `CLOUDSTACK_METHOD`. Варианты: `"get"` ← (по умолчанию) `"post"`
api_key string / обязательный	Ключ API CloudStack. Если значение не задано, используется переменная окружения `CLOUDSTACK_KEY`.
api_secret string / обязательный	Секретный ключ API CloudStack. Если значение не задано, используется переменная окружения `CLOUDSTACK_SECRET`.
api_timeout integer	Тайм-аут HTTP в секундах. Если значение не задано, используется переменная окружения `CLOUDSTACK_TIMEOUT`. По умолчанию: `10`
api_url string / обязательный	URL API CloudStack, например https://cloud.example.com/client/api. Если значение не задано, используется переменная окружения `CLOUDSTACK_ENDPOINT`.
api_verify_ssl_cert string	Проверять файл сертификата центра сертификации. Если значение не задано, используется переменная окружения `CLOUDSTACK_VERIFY`.
domain string	Домен, к которому относится открытый ключ.
name string / обязательный	Имя открытого ключа.
project string	Имя проекта, в котором будет зарегистрирован открытый ключ.
public_key string	Строка с открытым ключом.
state string	Состояние открытого ключа. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs boolean добавлен в ngine_io.cloudstack 2.4.0	Если `false`, проверка SSL-сертификатов выполняться не будет. Если значение не задано, используется переменная окружения `CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY`. Этот параметр следует использовать только на контролируемых вами ресурсах с самоподписанными сертификатами. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Подробное руководство по модулям CloudStack см. в руководстве по облаку CloudStack.
Этот модуль поддерживает режим проверки.

Примеры

- name: create a new private / public key pair
  ngine_io.cloudstack.ssh_key:
    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.ssh_key:
    name: linus@example.com
    state: absent

- name: register your existing local public key
  ngine_io.cloudstack.ssh_key:
    name: linus@example.com
    public_key: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
fingerprint string	Отпечаток открытого SSH-ключа. Возвращается: success Пример: `"86:5e:a3:e8:bd:95:7b:07:7c:c2:5c:f7:ad:8b:09:28"`
id string	UUID открытого SSH-ключа. Возвращается: success Пример: `"a6f7a5fc-43f8-11e5-a151-feff819cdc9f"`
name string	Имя открытого SSH-ключа. Возвращается: success Пример: `"linus@example.com"`
private_key string	Закрытый ключ созданной пары SSH-ключей. Возвращается: changed Пример: `"-----BEGIN RSA PRIVATE KEY----- MII...8tO -----END RSA PRIVATE KEY----- "`

Авторы

René Moser (@resmo)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/ngine_io/cloudstack/ssh_key_module.html