os_security_group_rule - Добавление/удаление правила из существующей группы безопасности
Новое в версии 2.0.
Обзор
- Добавление или удаление правила из существующей группы безопасности
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- shade
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени должен ждать уровень сокета, прежде чем истечёт время ожидания для API-вызовов. Если это опущено, ничего не будет передано в библиотеку requests. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую для стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать любые требуемые параметры. Этот параметр не нужен, если предоставлен имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type | Имя подключаемого модуля авторизации для использования. Если облако использует что-то помимо парольной аутентификации, имя подключаемого модуля должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | Игнорируется. Присутствует для обратной совместимости | |
| cacert | Путь к пакету сертификатов CA, который можно использовать для проверки запросов к API SSL. | |
| cert | Путь к клиентскому сертификату для использования в рамках транзакции SSL. | |
| 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 |
| key | Путь к клиентскому ключу для использования в рамках транзакции SSL. | |
| port_range_max | Значение по умолчанию: None | Конечный порт |
| port_range_min | Значение по умолчанию: None | Начальный порт |
| protocol |
| 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 или absent. |
| timeout | Значение по умолчанию: 180 | Сколько времени Ansible должен ждать запрошенного ресурса. |
| verify |
| Должны ли быть проверены запросы к API SSL. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait |
| Должен ли Ansible ждать, пока запрошенный ресурс не будет завершён. |
Примечания
Примечание
- Можно использовать стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об аутентификации управляется os-client-config, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, а затем, наконец, из явных параметров в сценариях. Дополнительную информацию можно найти по адресу http://docs.openstack.org/developer/os-client-config
Примеры
# 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 строка | 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 | Идентификатор группы безопасности, который необходимо связать с этим правилом группы безопасности. |
Статус
Этот модуль помечен как экспериментальный, что означает, что он не гарантирует обратную совместимость.
Автор
- 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.5/modules/os_security_group_rule_module.html
