openstack.cloud.keypair_info модуль — Получение информации о парах ключей из OpenStack
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.2.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля потребуются дополнительные зависимости. Подробности см. в разделе Требования.
Чтобы использовать его в playbook, укажите: openstack.cloud.keypair_info.
Обзор
- Получение информации о парах ключей, связанных с учетной записью
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Комментарии |
|---|---|
api_timeout целое число | Сколько времени должна ждать система сокетов перед истечением времени ожидания для API-вызовов. Если этот параметр опущен, библиотека requests ничего не получит. |
auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password он будет содержать auth_url, username, password, project_name и любые данные о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры плагина авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. |
auth_type строка | Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, здесь следует указать имя плагина, и содержимое параметра auth должно быть обновлено соответственно. |
ca_cert псевдонимы: cacert строка | Путь к файлу с сертификатом CA, который может использоваться для проверки запросов API SSL. |
client_cert псевдонимы: cert строка | Путь к файлу с клиентом сертификатом для использования в SSL-транзакции. |
client_key псевдонимы: key строка | Путь к файлу с ключом клиента для использования в SSL-транзакции. |
cloud любой тип | Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на конфигурацию именованного облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные окружения OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. |
interface псевдонимы: endpoint_type строка | Тип URL конечной точки для получения из каталога служб. Варианты:
|
limit целое число | Запрашивает размер страницы элементов. Возвращает количество элементов до заданного предела. |
marker строка | Последний просмотренный элемент. |
name строка | Имя или ID пары ключей |
region_name строка | Название региона. |
sdk_log_level строка | Уровень ведения журнала OpenStackSDK Варианты:
|
sdk_log_path строка | Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается |
timeout целое число | Сколько времени Ansible должен ждать запрошенного ресурса. По умолчанию: |
user_id строка | Позволяет администраторам управлять парами ключей указанного идентификатора пользователя. |
validate_certs псевдонимы: verify логическое значение | Нужно ли проверять запросы API SSL. До Ansible 2.3 по умолчанию было Варианты:
|
wait логическое значение | Должен ли Ansible ждать, пока завершится запрашиваемый ресурс. Варианты:
|
Примечания
Примечание
- Можно использовать стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации обрабатывается openstacksdk, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, и наконец, явных параметров в playbooks. Дополнительная информация доступна на https://docs.openstack.org/openstacksdk/
Примеры
- name: Get information about keypairs
openstack.cloud.keypair_info:
register: result
- name: Get information about keypairs using optional parameters
openstack.cloud.keypair_info:
name: "test"
user_id: "fed75b36fd7a4078a769178d2b1bd844"
limit: 10
marker: "jdksl"
register: result
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
keypairs список / элементы=словарь | Список пар ключей, связанных с учетной записью. Возвращается: всегда |
|
created_at строка |
Дата и время создания ресурса. Возвращается: успешно Пример: |
|
fingerprint строка |
Отпечаток пальца пары ключей. Возвращается: успешно Пример: |
|
id строка |
Идентификатор пары ключей. Возвращается: успешно Пример: |
|
is_deleted булево |
Булево значение, указывающее, удалена ли пара ключей. Возвращается: успешно |
|
name строка |
Имя пары ключей, которое будет использоваться для ссылки на неё позже. Возвращается: успешно Пример: |
|
private_key строка |
Приватный ключ пары ключей. Возвращается: успешно Пример: |
|
public_key строка |
Публичный ключ пары ключей. Возвращается: успешно Пример: |
|
type строка |
Тип пары ключей. Допустимые значения: ssh или x509. Возвращается: успешно Пример: |
|
user_id строка |
Позволяет администраторам управлять парами ключей указанного идентификатора пользователя. Возвращается: успешно Пример: |
Ссылки на коллекцию
© 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/openstack/cloud/keypair_info_module.html
