Spec-Zone.ru › Ansible

Модуль openstack.cloud.security_group_info — выводит список групп безопасности

Примечание

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

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

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

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

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

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

  • Выводит список групп безопасности

Требования

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

  • python >= 3.6
  • openstacksdk >= 1.0.0

Параметры

Параметр

Комментарии

any_tags

list / elements=string

Список тегов для фильтрации результатов.

Будут возвращены ресурсы, соответствующие любому тегу из этого списка.

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.

description

string

Описание группы безопасности.

interface

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

string

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

Варианты:

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

name

string

Имя или идентификатор группы безопасности.

not_any_tags

list / elements=string

Список тегов для фильтрации результатов.

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

not_tags

list / elements=string

Список тегов для фильтрации результатов.

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

project_id

string

Использует идентификатор проекта в качестве критерия фильтрации.

region_name

string

Имя региона.

revision_number

integer

Фильтрует результаты по номеру редакции ресурса.

sdk_log_level

string

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

Варианты:

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

sdk_log_path

string

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

tags

list / elements=string

Список тегов для фильтрации результатов.

Будут возвращены ресурсы, соответствующие всем тегам из этого списка.

timeout

integer

Время ожидания ресурса, запрошенного Ansible.

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

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 all security groups
  openstack.cloud.security_group_info:
    cloud: devstack

- name: Get specific security group
  openstack.cloud.security_group_info:
    cloud: devstack
    name: my_sg

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

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

Ключ

Описание

security_groups

list / elements=dictionary

Список словарей с описаниями групп безопасности.

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

created_at

string

Время создания группы безопасности

Возвращается: при успешном выполнении

Пример: "yyyy-mm-dd hh:mm:ss"

description

string

Описание группы безопасности

Возвращается: при успешном выполнении

Пример: "My security group"

id

string

Идентификатор группы безопасности

Возвращается: при успешном выполнении

Пример: "d90e55ba-23bd-4d97-b722-8cb6fb485d69"

name

string

Имя группы безопасности.

Возвращается: при успешном выполнении

Пример: "my-sg"

project_id

string

Идентификатор проекта, в котором находится группа безопасности.

Возвращается: при успешном выполнении

Пример: "25d24fc8-d019-4a34-9fff-0a09fde6a567"

revision_number

integer

Номер редакции ресурса.

Возвращается: при успешном выполнении

security_group_rules

list / elements=string

Список правил группы безопасности

Возвращается: при успешном выполнении

Пример: [{"description": null, "direction": "ingress", "ethertype": "IPv4", "id": "d90e55ba-23bd-4d97-b722-8cb6fb485d69", "port_range_max": null, "port_range_min": null, "protocol": null, "remote_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2", "remote_ip_prefix": null, "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2", "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c"}, {"description": null, "direction": "egress", "ethertype": "IPv4", "id": "aecff4d4-9ce9-489c-86a3-803aedec65f7", "port_range_max": null, "port_range_min": null, "protocol": null, "remote_group_id": null, "remote_ip_prefix": null, "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2", "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c"}]

stateful

boolean

Указывает, является ли группа безопасности отслеживающей состояние или не отслеживающей состояние.

Возвращается: при успешном выполнении

tags

list / elements=string

Список тегов ресурса.

Возвращается: при успешном выполнении

tenant_id

string

Идентификатор арендатора, в котором находится группа безопасности. Устарел.

Возвращается: при успешном выполнении

Пример: "25d24fc8-d019-4a34-9fff-0a09fde6a567"

updated_at

string

Время обновления группы безопасности

Возвращается: при успешном выполнении

Пример: "yyyy-mm-dd hh:mm:ss"

Авторы

  • Специальная группа 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/security_group_info_module.html

Spec-Zone.ru

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