Spec-Zone.ru › Ansible

Модуль openstack.cloud.keypair_info — получение информации о парах ключей из OpenStack

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.keypair_info.

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

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

  • Получение информации о парах ключей, связанных с учётной записью

Требования

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

  • python >= 3.6
  • openstacksdk >= 1.0.0

Параметры

Параметр

Описание

api_timeout

integer

Время ожидания сокетного уровня перед истечением времени ожидания вызовов API. Если параметр не указан, библиотеке requests ничего не передаётся.

auth

dictionary

Словарь с данными аутентификации, необходимыми для выбранной стратегии плагина аутентификации облака. Для стандартного плагина password в нём должны содержаться auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать все параметры, необходимые соответствующему плагину аутентификации. Этот параметр не требуется, если указано именованное облако или заданы переменные окружения OpenStack OS_*.

auth_type

string

Имя используемого плагина аутентификации. Если облако использует не парольную аутентификацию, здесь следует указать имя плагина и соответствующим образом обновить содержимое параметра auth.

ca_cert

псевдонимы: cacert

string

Путь к пакету сертификатов CA, который можно использовать для проверки запросов API по SSL.

client_cert

псевдонимы: cert

string

Путь к сертификату клиента, используемому в транзакции SSL.

client_key

псевдонимы: key

string

Путь к ключу клиента, используемому в транзакции SSL.

cloud

any

Именованное облако или конфигурация облака, с которыми нужно работать. Если cloud — строка, она указывает на именованную конфигурацию облака, заданную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или заданы переменные окружения OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, аналогичную разделу файла clouds.yaml.

interface

псевдонимы: endpoint_type

string

Тип URL конечной точки, получаемой из каталога служб.

Варианты:

  • "admin"
  • "internal"
  • "public" ← (по умолчанию)

limit

integer

Запрашивает размер страницы в элементах.

Возвращает не более указанного значения limit элементов.

marker

string

Последний просмотренный элемент.

name

string

Имя или ID пары ключей

region_name

string

Имя региона.

sdk_log_level

string

Уровень ведения журнала OpenStackSDK

Варианты:

  • "INFO" ← (по умолчанию)
  • "DEBUG"

sdk_log_path

string

Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не ведётся.

timeout

integer

Как долго Ansible должен ожидать запрошенный ресурс.

По умолчанию: 180

user_id

string

Позволяет пользователям с правами администратора работать с парами ключей указанного пользователя.

validate_certs

псевдонимы: verify

boolean

Нужно ли проверять запросы API по SSL.

До Ansible 2.3 значение по умолчанию было true.

Варианты:

  • false
  • true

wait

boolean

Должен ли Ansible ожидать завершения операции с запрошенным ресурсом.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Вместо указания явных значений можно использовать стандартные переменные окружения OpenStack, например OS_USERNAME.
  • Данные аутентификации обрабатываются openstacksdk. Это означает, что значения могут быть получены из файла конфигурации YAML /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения и, наконец, из явных параметров в плейбуках. Дополнительную информацию см. на странице 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

list / elements=dictionary

Список пар ключей, связанных с учётной записью.

Возвращается: всегда

created_at

string

Дата и время создания ресурса.

Возвращается: при успехе

Пример: "2021-01-19T14:52:07.261634"

fingerprint

string

Отпечаток пары ключей.

Возвращается: при успехе

Пример: "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd"

id

string

Идентификатор пары ключей

Возвращается: при успехе

Пример: "keypair-5d935425-31d5-48a7-a0f1-e76e9813f2c3"

is_deleted

boolean

Логическое значение, указывающее, удалена ли эта пара ключей.

Возвращается: при успехе

name

string

Имя пары ключей, используемое для дальнейшей ссылки на неё.

Возвращается: при успехе

Пример: "keypair-5d935425-31d5-48a7-a0f1-e76e9813f2c3"

private_key

string

Закрытый ключ пары ключей.

Возвращается: при успехе

Пример: "MIICXAIBAAKBgQCqGKukO ... hZj6+H0qtjTkVxwTCpvKe4eCZ0FPq"

public_key

string

Открытый ключ пары ключей.

Возвращается: при успехе

Пример: "ssh-rsa AAAAB3NzaC1yc ... 8rPsBUHNLQp Generated-by-Nova"

type

string

Тип пары ключей.

Допустимые значения: ssh или x509.

Возвращается: при успехе

Пример: "ssh"

user_id

string

Позволяет пользователям с правами администратора работать с парами ключей указанного пользователя.

Возвращается: при успехе

Пример: "59b10f2a2138428ea9358e10c7e44444"

Авторы

  • Специальная группа OpenStack Ansible

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

  • Отслеживание ошибок
  • Репозиторий (исходный код)

© 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/openstack/cloud/keypair_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API