openstack.cloud.security_group модуль — Управление группами безопасности Neutron в облаке OpenStack.

Примечание

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

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

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

Для использования в плейбуке укажите: openstack.cloud.security_group.

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

Обзор

Добавление или удаление групп безопасности Neutron в/из облака OpenStack.

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
api_timeout целое число	Сколько времени должно ждать сокетное соединение перед истечением времени ожидания для вызовов API. Если это опущено, ничего не будет передано в библиотеку запросов.
auth словарь	Словарь, содержащий информацию об авторизации, необходимую для стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать необходимые параметры подключаемого модуля авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type строка	Название подключаемого модуля авторизации для использования. Если облако использует что-то отличное от парольной аутентификации, здесь должно быть указано название подключаемого модуля, и содержимое параметра auth должно быть соответствующим образом обновлено.
ca_cert алиасы: cacert строка	Путь к пакету сертификатов CA, который может использоваться для проверки запросов API SSL.
client_cert алиасы: cert строка	Путь к клиенту сертификату для использования в рамках транзакции SSL.
client_key алиасы: key строка	Путь к ключу клиента для использования в рамках транзакции SSL.
cloud любой	Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен параметр auth или если присутствуют переменные окружения OpenStack OS_* . Если cloud — словарь, он содержит полную конфигурацию облака, как это представлено в разделе clouds.yaml.
description строка	Подробное описание назначения группы безопасности.
interface алиасы: endpoint_type строка	Тип URL конечной точки для извлечения из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name строка / обязательно	Имя, которое должно быть задано для группы безопасности. Этот модуль требует, чтобы имена групп безопасности были уникальными.
project строка	Уникальное имя или идентификатор проекта.
region_name строка	Название региона.
sdk_log_level строка	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path строка	Путь к файлу журнала OpenStackSDK. Если пусто, журнал не будет записан.
security_group_rules список / элементы=словарь	Список правил группы безопасности. Когда security_group_rules не определён, Neutron может создать эту группу безопасности с набором правил по умолчанию. Правила группы безопасности, указанные в security_group_rules, но не определенные в этой группе безопасности, будут созданы. Если security_group_rules не установлен, существующие правила группы безопасности, которые не указаны в security_group_rules, будут удалены. При обновлении группы безопасности необходимо явно указать правила из значений по умолчанию Neutron в security_group_rules, если эти правила должны сохраниться. Правила, которые не указаны в security_group_rules, будут удалены.
description строка	Описание правила группы безопасности.
direction строка	Направление применения правила группы безопасности. Не все поставщики поддерживают `egress`. Варианты: `"egress"` `"ingress"` ← (по умолчанию)
ether_type строка	Должно быть IPv4 или IPv6, а адреса, представленные в CIDR, должны соответствовать правилам входа или выхода. Не все поставщики поддерживают IPv6. Варианты: `"IPv4"` ← (по умолчанию) `"IPv6"`

port_range_max целое число	Максимальное значение порта в диапазоне, которое соответствует правилу безопасности группы. Если протокол TCP, UDP, DCCP, SCTP или UDP-Lite, это значение должно быть больше или равно значению атрибута port_range_min. Если протокол ICMP, это значение должно быть кодом ICMP.
port_range_min целое число	Минимальное значение порта в диапазоне, которое соответствует правилу безопасности группы. Если протокол TCP, UDP, DCCP, SCTP или UDP-Lite, это значение должно быть меньше или равно значению атрибута port_range_max. Если протокол ICMP, это значение должно быть типом ICMP.
protocol строка	Протокол IP может быть представлен строкой, целым числом или null. Допустимые строковые или целочисленные значения: `any` или `0`, `ah` или `51`, `dccp` или `33`, `egp` или `8`, `esp` или `50`, `gre` или `47`, `icmp` или `1`, `icmpv6` или `58`, `igmp` или `2`, `ipip` или `4`, `ipv6-encap` или `41`, `ipv6-frag` или `44`, `ipv6-icmp` или `58`, `ipv6-nonxt` или `59`, `ipv6-opts` или `60`, `ipv6-route` или `43`, `ospf` или `89`, `pgm` или `113`, `rsvp` или `46`, `sctp` или `132`, `tcp` или `6`, `udp` или `17`, `udplite` или `136`, `vrrp` или `112`. Также любое целое значение между `[0-255]` является допустимым. Строка any (или целое число 0) означает все протоколы IP. См. константы в neutron_lib.constants для самого актуального списка поддерживаемых строк.
remote_group строка	Имя или ID группы безопасности для связи. Взаимоисключающие с remote_ip_prefix.
remote_ip_prefix строка	Адрес(ы) исходного IP-адреса в нотации CIDR. Когда маска сети, например `/32` отсутствует в remote_ip_prefix, тогда этот модуль завершится сбоем при обновлениях с сообщением об ошибке OpenStack `Security group rule already exists.`. Взаимоисключающие с remote_group.
state строка	Должен ли ресурс быть присутствующим или отсутствующим. Варианты: `"present"` ← (по умолчанию) `"absent"`
stateful булево	Должен ли ресурс быть состоятельным или бессостоятельным. Варианты: `false` `true`
timeout целое число	Сколько времени Ansible должен ждать запрашиваемого ресурса. По умолчанию: `180`
validate_certs псевдонимы: verify булево	Нужно ли проверять запросы API SSL. До Ansible 2.3 это по умолчанию было `true`. Варианты: `false` `true`
wait булево	Должен ли 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: Create a security group
  openstack.cloud.security_group:
    cloud: mordred
    state: present
    name: foo
    description: security group for foo servers

- name: Create a stateless security group
  openstack.cloud.security_group:
    cloud: mordred
    state: present
    stateful: false
    name: foo
    description: stateless security group for foo servers

- name: Update the existing 'foo' security group description
  openstack.cloud.security_group:
    cloud: mordred
    state: present
    name: foo
    description: updated description for the foo security group

- name: Create a security group for a given project
  openstack.cloud.security_group:
    cloud: mordred
    state: present
    name: foo
    project: myproj

- name: Create (or update) a security group with security group rules
  openstack.cloud.security_group:
    cloud: mordred
    state: present
    name: foo
    security_group_rules:
      - ether_type: IPv6
        direction: egress
      - ether_type: IPv4
        direction: egress

- name: Create (or update) security group without security group rules
  openstack.cloud.security_group:
    cloud: mordred
    state: present
    name: foo
    security_group_rules: []

Значения возврата

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

Ключ	Описание
security_group словарь	Словарь, описывающий группу безопасности. Возвращается: при успехе, когда state равен `present`.
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_module.html