os_security_group_rule – Добавление/удаление правила из существующей группы безопасности
Описание
- Добавление или удаление правила из существующей группы безопасности
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- 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 строка |
| Тип URL конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type |
| port_range_max - | Конечный порт | |
| port_range_min - | Начальный порт | |
| project - добавлено в 2.7 | Уникальное имя или идентификатор проекта. | |
| protocol - |
| IP протоколы TCP UDP ICMP 112 (VRRP) |
| region_name строка | Имя региона. | |
| remote_group - | Имя или ID группы безопасности для подключения (исключительно с remote_ip_prefix) | |
| remote_ip_prefix - | Адрес(ы) источника IP в формате CIDR (исключительно с remote_group) | |
| security_group - / обязательно | Имя или идентификатор группы безопасности | |
| state - |
| Должен ли ресурс присутствовать или отсутствовать. |
| 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.9/modules/os_security_group_rule_module.html
