Spec-Zone.ru › Ansible

openstack.cloud.security_group_rule_info модуль – Получение правил безопасности групп сетей OpenStack (Neutron)

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: openstack.cloud.security_group_rule_info.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Получение правил безопасности групп сетей из API OpenStack network (Neutron).

Требования

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

  • 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, который может использоваться для проверки запросов SSL API.

client_cert

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

строка

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

client_key

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

строка

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

cloud

любой

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

description

строка

Фильтрует результат списка по удобочитаемому описанию ресурса.

direction

строка

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

Выбор:

  • "egress"
  • "ingress"

ether_type

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

строка

Фильтрует результат списка правил группы безопасности по типу ether_type сетевого трафика. Значение должно быть IPv4 или IPv6.

Выбор:

  • "IPv4"
  • "IPv6"

id

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

строка

Фильтрует результат списка по ID правила группы безопасности.

interface

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

строка

Тип URL конечной точки для извлечения из каталога сервисов.

Выбор:

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

port_range_max

целое число

Конечный порт

port_range_min

целое число

Начальный порт

project

строка

Уникальное имя или ID проекта.

protocol

строка

Фильтрует результат списка правил группы безопасности по протоколу IP.

region_name

строка

Имя региона.

remote_group

строка

Фильтрует результат списка правил группы безопасности по имени или ID удалённой группы, связанной с этим правилом группы безопасности.

remote_ip_prefix

строка

Адрес(ы) источника IP в нотации CIDR (исключительно с remote_group)

revision_number

целое число

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

sdk_log_level

string

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

Варианты:

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

sdk_log_path

string

Путь к файлу логов OpenStackSDK. Если пусто, логи не будут записываться

security_group

string

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

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, а затем из стандартных переменных окружения, и наконец, из явных параметров в play. Более подробную информацию можно найти на странице https://docs.openstack.org/openstacksdk/

Примеры

- name: Fetch all security group rules
  openstack.cloud.security_group_rule_info:
    cloud: devstack

- name: Filter security group rules for port 80 and name
  openstack.cloud.security_group_rule_info:
    cloud: devstack
    security_group: foo
    protocol: tcp
    port_range_min: 80
    port_range_max: 80
    remote_ip_prefix: 0.0.0.0/0

- name: Filter for ICMP rules
  openstack.cloud.security_group_rule_info:
    cloud: devstack
    protocol: icmp

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

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

Ключ

Описание

security_group_rules

list / elements=dictionary

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

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

created_at

string

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

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

description

string

Описание ресурса, понятное человеку.

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

Пример: "My description."

direction

string

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

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

Пример: "egress"

ether_type

string

IPv4 или IPv6.

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

Пример: "IPv4"

id

string

Уникальный UUID правила.

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

name

string

Имя ресурса.

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

port_range_max

integer

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

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

Пример: 8000

port_range_min

integer

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

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

Пример: 8000

project_id

string

ID проекта.

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

Пример: "e4f50856753b4dc6afee5fa6b9b6c550"

protocol

string

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

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

Пример: "tcp"

remote_address_group_id

string

ID удаленной группы адресов, которая будет связана с этим правилом группы безопасности.

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

remote_group_id

string

ID удаленной группы безопасности, которая будет связана с этим правилом группы безопасности.

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

remote_ip_prefix

string

Префикс удаленного IP-адреса, который будет связан с этим правилом группы безопасности.

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

revision_number

string

Префикс удаленного IP-адреса, который будет связан с этим правилом группы безопасности.

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

Пример: "0.0.0.0/0"

security_group_id

string

ID группы безопасности, который будет связан с этим правилом группы безопасности.

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

Пример: "729b9660-a20a-41fe-bae6-ed8fa7f69123"

tags

string

ID группы безопасности, который будет связан с этим правилом группы безопасности.

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

Пример: "729b9660-a20a-41fe-bae6-ed8fa7f69123"

tenant_id

string

ID проекта. Устарело.

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

Пример: "e4f50856753b4dc6afee5fa6b9b6c550"

updated_at

string

Время обновления ресурса (в формате UTC ISO8601).

Возвращаемое значение: успех

Пример: "2018-03-19T19:16:56Z"

Авторы

  • 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_rule_info_module.html

Spec-Zone.ru

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