os_security_group_rule – Добавление/удаление правила из существующей группы безопасности
Новая версия с 2.0.
Описание
- Добавить или удалить правило из существующей группы безопасности
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout - | Время ожидания сокета при вызовах API. Если этот параметр опущен, библиотека requests не получит его. | |
| auth - | Словарь, содержащий информацию об аутентификации, необходимую для стратегии подключаемого модуля аутентификации облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о домене, если облако её поддерживает. Для других плагинов этот параметр должен содержать параметры, необходимые указанному плагину. Этот параметр не требуется, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type - | Имя плагина аутентификации для использования. Если облако использует что-то другое, помимо парольной аутентификации, здесь должно быть указано имя плагина, а содержимое параметра auth должно быть обновлено соответственно. | |
| availability_zone - | Игнорируется. Присутствует для обратной совместимости | |
| cacert - | Путь к пакету сертификатов CA, который может быть использован для проверки SSL запросов API. | |
| 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 - | Конечный порт | |
| port_range_min - | Начальный порт | |
| project - добавлено в 2.7 | Уникальное имя или ID проекта. | |
| 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 - |
| Должен ли ресурс быть присутствующим или отсутствующим. |
| timeout - | По умолчанию: 180 | Сколько времени Ansible должно ждать запрошенного ресурса. |
| verify boolean |
| Должны ли проверяться SSL запросы API. До версии 2.3 значение по умолчанию было True. псевдонимы: validate_certs |
| wait boolean |
| Должен ли Ansible ждать, пока запрошенный ресурс не будет завершён. |
Примечания
Примечание
- Стандартные переменные окружения 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
Примеры
# 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 | ID группы безопасности, который нужно связать с этим правилом группы безопасности. |
Статус
- Данный модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом 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.7/modules/os_security_group_rule_module.html
