Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

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

Требования

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

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

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

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

direction

string

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

Варианты:

  • "egress"
  • "ingress"

ether_type

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

string

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

Варианты:

  • "IPv4"
  • "IPv6"

id

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

string

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

interface

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

string

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

Варианты:

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

port_range_max

integer

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

port_range_min

integer

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

project

string

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

protocol

string

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

region_name

string

Название региона.

remote_group

string

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

remote_ip_prefix

string

Исходные IP-адреса в нотации CIDR (не используется одновременно с remote_group)

revision_number

integer

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

sdk_log_level

string

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

Варианты:

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

sdk_log_path

string

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

security_group

string

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

timeout

integer

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

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

validate_certs

псевдонимы: 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: 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 / элементы=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

Идентификатор проекта.

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

Пример: "e4f50856753b4dc6afee5fa6b9b6c550"

protocol

string

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

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

Пример: "tcp"

remote_address_group_id

string

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

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

remote_group_id

string

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

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

remote_ip_prefix

string

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

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

revision_number

string

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

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

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

security_group_id

string

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

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

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

tags

string

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

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

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

tenant_id

string

Идентификатор проекта. Устарело.

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

Пример: "e4f50856753b4dc6afee5fa6b9b6c550"

updated_at

string

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

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

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

Авторы

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

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

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

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

Spec-Zone.ru

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