Spec-Zone.ru › Ansible

openstack.cloud.security_group_info модуль – Список групп безопасности

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.2.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
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

any_tags

list / elements=string

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

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

api_timeout

integer

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

auth

dictionary

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

auth_type

string

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

ca_cert

aliases: cacert

string

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

client_cert

aliases: cert

string

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

client_key

aliases: key

string

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

cloud

any

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

description

string

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

interface

aliases: 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

aliases: verify

boolean

Проверять ли SSL-запросы API.

До 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

список / элементы=словарь

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

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

created_at

строка

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

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

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

description

строка

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

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

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

id

строка

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

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

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

name

строка

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

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

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

project_id

строка

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

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

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

revision_number

целое число

Номер версии ресурса.

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

security_group_rules

список / элементы=строка

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

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

Пример: [{"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

булево

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

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

tags

список / элементы=строка

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

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

tenant_id

строка

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

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

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

updated_at

строка

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

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

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

Авторы

  • OpenStack Ansible SIG

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

  • Система отслеживания ошибок
  • Репозиторий (источники)

© 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/security_group_info_module.html

Spec-Zone.ru

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