os_security_group_rule - Добавление/удаление правила из существующей группы безопасности
Новая версия с 2.0.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Добавление или удаление правила из существующей группы безопасности
Требования (к хосту, на котором выполняется модуль)
- python >= 2.7
- shade
Параметры
| параметр | обязательный | по умолчанию | возможные значения | комментарии |
|---|---|---|---|---|
| api_timeout | нет | None | Сколько времени должна ждать сокетная прослойка перед временным ограничением для вызовов API. Если это опущено, ничего не будет передано в библиотеку запросов. | |
| auth | нет | Словарь, содержащий информацию об авторизации, как требуется стратегией плагина авторизации облака. Для стандартного плагина password он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать любые параметры, необходимые для этого плагина авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*. | ||
| auth_type | нет | password | Имя плагина авторизации для использования. Если облако использует что-то отличное от парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | нет | Игнорируется. Присутствует для обратной совместимости | ||
| cacert | нет | None | Путь к пакету CA Cert, который может быть использован для проверки SSL-запросов к API. | |
| cert | нет | None | Путь к клиенту сертификату для использования в рамках SSL-транзакции. | |
| cloud | нет | Именованное облако для работы. Обеспечивает значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные среды OpenStack OS_*. | ||
| direction | нет | ingress |
| Направление, в котором применяется правило группы безопасности. Не все поставщики поддерживают egress. |
| endpoint_type | нет | public |
| Тип URL конечной точки для извлечения из каталога служб. |
| ethertype | нет | IPv4 |
| Должно быть IPv4 или IPv6, и адреса, представленные в CIDR, должны соответствовать правилам ingress или egress. Не все поставщики поддерживают IPv6. |
| key | нет | None | Путь к ключу клиента для использования в рамках SSL-транзакции. | |
| port_range_max | нет | None | Конечный порт | |
| port_range_min | нет | None | Начальный порт | |
| protocol | нет | None |
| IP-протоколы TCP UDP ICMP 112 (VRRP) |
| region_name | нет | Имя региона. | ||
| remote_group | нет | Имя или ID группы безопасности для связки (исключительно с remote_ip_prefix) | ||
| remote_ip_prefix | нет | Адрес(ы) IP источника в CIDR-нотации (исключительно с remote_group) | ||
| security_group | да | Имя или ID группы безопасности | ||
| state | нет | present |
| Ресурс должен быть присутствующим или отсутствующим. |
| timeout | нет | 180 | Сколько времени Ansible должен ждать запрошенного ресурса. | |
| validate_certs | нет | Требуется ли проверка SSL-запросов к API. До версии 2.3 значение по умолчанию было True. псевдонимы: verify | ||
| wait | нет | yes |
| Должен ли Ansible ждать, пока запрошенный ресурс не будет завершён. |
Примеры
# 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
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| direction | Направление, в котором применяется правило группы безопасности. | state == present | строка | egress |
| ethertype | Один из IPv4 или IPv6. | state == present | строка | IPv4 |
| id | Уникальный UUID правила. | state == present | строка | |
| port_range_max | Максимальный номер порта в диапазоне, который соответствует правилу группы безопасности. | state == present | целое число | 8000 |
| port_range_min | Минимальный номер порта в диапазоне, который соответствует правилу группы безопасности. | state == present | целое число | 8000 |
| protocol | Протокол, который соответствует правилу группы безопасности. | state == present | строка | tcp |
| remote_ip_prefix | Префикс удалённого IP-адреса, который должен быть связан с этим правилом группы безопасности. | state == present | строка | 0.0.0.0/0 |
| security_group_id | Идентификатор группы безопасности, который нужно связать с этим правилом группы безопасности. | state == present | строка |
Примечания
Примечание
- Можно использовать стандартные переменные среды OpenStack, такие как
OS_USERNAMEвместо предоставления явных значений. - Информация об авторизации управляется os-client-config, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, а затем из стандартных переменных среды, а затем, наконец, из явных параметров в playbooks. Более подробную информацию можно найти по адресу http://docs.openstack.org/developer/os-client-config
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется обратной совместимостью.
Для получения помощи в разработке модулей, если вы так захотите, пожалуйста, ознакомьтесь с Справочной информацией о сообществе и участии в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/os_security_group_rule_module.html