os_security_group_rule – Добавление/удаление правила из существующей группы безопасности
Новая версия 2.0.
Обзор
- Добавление или удаление правила из существующей группы безопасности
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени (в секундах) сокетный уровень должен ожидать перед истечением времени ожидания для API-вызовов. Если это значение опущено, к библиотеке запросов ничего не будет передано. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для плагина password по умолчанию он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, os_user_domain_name или os_project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры плагина авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*. | |
| auth_type строка | Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone - | Игнорируется. Присутствует для обратной совместимости | |
| ca_cert строка | Путь к пакету сертификатов CA, который может использоваться для проверки SSL-API-запросов. псевдонимы: cacert | |
| client_cert строка | Путь к клиенту сертификат для использования в рамках SSL-транзакции. псевдонимы: cert | |
| client_key строка | Путь к ключу клиента для использования в рамках SSL-транзакции. псевдонимы: key | |
| cloud сырые данные | Именованное облако или конфигурация облака для работы с ним. Если cloud является строкой, она ссылается на конфигурацию именованного облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные среды OpenStack OS_*. Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| direction - |
| Направление, в котором применяется правило группы безопасности. Не все поставщики поддерживают egress. |
| ethertype - |
| Должно быть IPv4 или IPv6, и адреса, представленные в CIDR, должны соответствовать правилам ingress или egress. Не все поставщики поддерживают IPv6. |
| interface строка добавлен в 2.3 |
| Тип URL конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| port_range_max - | Конечный порт | |
| port_range_min - | Начальный порт | |
| project - добавлен в 2.7 | Уникальное имя или идентификатор проекта. | |
| protocol - |
| IP-протоколы TCP UDP ICMP 112 (VRRP) |
| region_name строка | Имя региона. | |
| remote_group - | Имя или идентификатор группы безопасности для связи (исключительно с remote_ip_prefix) | |
| remote_ip_prefix - | Адрес(ы) источника IP в CIDR-нотации (исключительно с remote_group) | |
| security_group - / обязательно | Имя или идентификатор группы безопасности | |
| state - |
| Ресурс должен быть present или absent. |
| timeout целое число | По умолчанию: 180 | Сколько времени Ansible должно ждать запрашиваемого ресурса. |
| validate_certs булево |
| Необходимо ли проверять SSL-API-запросы. До Ansible 2.3 это по умолчанию было yes. псевдонимы: verify |
| wait булево |
| Должен ли Ansible ждать, пока запрашиваемый ресурс будет завершен. |
Примечания
Примечание
- Могут использоваться стандартные переменные среды OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется openstacksdk, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, и, наконец, из явных параметров в задачах. Дополнительную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/
Примеры
# Create a security group rule
- os_security_group_rule:
cloud: mordred
security_group: foo
protocol: tcp
port_range_min: 80
port_range_max: 80
remote_ip_prefix: 0.0.0.0/0
# Create a security group rule for ping
- os_security_group_rule:
cloud: mordred
security_group: foo
protocol: icmp
remote_ip_prefix: 0.0.0.0/0
# Another way to create the ping rule
- os_security_group_rule:
cloud: mordred
security_group: foo
protocol: icmp
port_range_min: -1
port_range_max: -1
remote_ip_prefix: 0.0.0.0/0
# Create a TCP rule covering all ports
- os_security_group_rule:
cloud: mordred
security_group: foo
protocol: tcp
port_range_min: 1
port_range_max: 65535
remote_ip_prefix: 0.0.0.0/0
# Another way to create the TCP rule above (defaults to all ports)
- os_security_group_rule:
cloud: mordred
security_group: foo
protocol: tcp
remote_ip_prefix: 0.0.0.0/0
# Create a rule for VRRP with numbered protocol 112
- os_security_group_rule:
security_group: loadbalancer_sg
protocol: 112
remote_group: loadbalancer-node_sg
# Create a security group rule for a given project
- os_security_group_rule:
cloud: mordred
security_group: foo
protocol: icmp
remote_ip_prefix: 0.0.0.0/0
project: myproj
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| direction строка | state == present | Направление, в котором применяется правило группы безопасности. Пример: egress |
| ethertype строка | state == present | Один из IPv4 или IPv6. Пример: IPv4 |
| id строка | state == present | Уникальный UUID правила. |
| port_range_max целое число | state == present | Максимальный номер порта в диапазоне, соответствующий правилу группы безопасности. Пример: 8000 |
| port_range_min целое число | state == present | Минимальный номер порта в диапазоне, соответствующий правилу группы безопасности. Пример: 8000 |
| protocol строка | state == present | Протокол, соответствующий правилу группы безопасности. Пример: tcp |
| remote_ip_prefix строка | state == present | Префикс удаленного IP-адреса, который необходимо связать с этим правилом группы безопасности. Пример: 0.0.0.0/0 |
| security_group_id строка | state == present | Идентификатор группы безопасности, который необходимо связать с этим правилом группы безопасности. |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Benno Joy (@bennojoy)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/os_security_group_rule_module.html
