cs_firewall – Управляет правилами брандмауэра в облаках Apache CloudStack
Новое в версии 2.0.
Обзор
- Создает и удаляет правила брандмауэра.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- cs >= 0.6.10
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account строка | Аккаунт, к которому относится правило брандмауэра. | |
| api_http_method строка |
| HTTP-метод, используемый для запроса к API-точке. Если не указано, используется значение переменной среды CLOUDSTACK_METHOD. В качестве последнего варианта значение берется из файла конфигурации ini, см. также примечания. Значение по умолчанию — get, если не указано. |
| api_key строка | API-ключ CloudStack API. Если не указано, используется значение переменной среды CLOUDSTACK_KEY. В качестве последнего варианта значение берется из файла конфигурации ini, см. также примечания. | |
| api_region строка | По умолчанию: "cloudstack" | Имя раздела ini в файле cloustack.ini. Если не указано, используется значение переменной среды CLOUDSTACK_REGION. |
| api_secret строка | Секретный ключ CloudStack API. Если не задан, используется значение переменной среды CLOUDSTACK_SECRET. В качестве последнего варианта значение берется из файла конфигурации ini, см. также примечания. | |
| api_timeout целое число | Таймаут HTTP в секундах. Если не указано, используется значение переменной среды CLOUDSTACK_TIMEOUT. В качестве последнего варианта значение берется из файла конфигурации ini, см. также примечания. Значение по умолчанию — 10 секунд, если не указано. | |
| api_url строка | URL CloudStack API, например, https://cloud.example.com/client/api. Если не указано, используется значение переменной среды CLOUDSTACK_ENDPOINT. В качестве последнего варианта значение берется из файла конфигурации ini, см. также примечания. | |
| cidrs список | По умолчанию: "0.0.0.0/0" | Список CIDR (полная запись) для использования в правиле брандмауэра. С версии 2.5 это список CIDR. псевдонимы: cidr |
| domain строка | Домен, к которому относится правило брандмауэра. | |
| end_port целое число | Конечный порт для этого правила. Используется, если protocol=tcp или protocol=udp. Если не указан, равен start_port. | |
| icmp_code целое число | Код ошибки для этого сообщения icmp. Используется, если protocol=icmp. | |
| icmp_type целое число | Тип сообщения icmp, отправляемого. Используется, если protocol=icmp. | |
| ip_address строка | Общедоступный IP-адрес, которому присвоено правило входящего трафика. Требуется, если type=ingress. | |
| network строка | Сеть, к которой относится правило исходящего трафика. Требуется, если type=egress. | |
| poll_async логическое значение |
| Опрашивать асинхронные задания, пока задание не завершится. |
| project строка | Название проекта, к которому относится правило брандмауэра. | |
| protocol строка |
| Протокол правила брандмауэра. all доступен только при type=egress. |
| start_port целое число | Начальный порт для этого правила. Используется, если protocol=tcp или protocol=udp. псевдонимы: port | |
| state строка |
| Состояние правила брандмауэра. |
| tags список добавлено в 2.4 | Список тегов. Теги представляют собой список словарей с ключами key и value. Для удаления всех тегов установите пустой список, например, tags: []. псевдонимы: tag | |
| type строка |
| Тип правила брандмауэра. |
| zone строка | Имя зоны, в которой находится виртуальная машина. Если не указано, используется зона по умолчанию. |
Примечания
Примечание
- Ansible использует метод конфигурации библиотеки
cs, если учетные данные не предоставлены аргументамиapi_url,api_key,api_secret. Конфигурация считывается из нескольких источников в указанном ниже порядке.CLOUDSTACK_ENDPOINT,CLOUDSTACK_KEY,CLOUDSTACK_SECRETиCLOUDSTACK_METHOD.CLOUDSTACK_TIMEOUTпеременные среды.CLOUDSTACK_CONFIGпеременная среды, указывающая на файл.ini. Файлcloudstack.iniв текущей рабочей директории. Файл.cloudstack.iniв домашнем каталоге пользователя. Допускается указание нескольких учетных данных и точек доступа с использованием разделов ini вcloudstack.ini. Используйте аргументapi_regionдля выбора имени раздела, по умолчанию используетсяcloudstack. Более подробную информацию можно найти на странице https://github.com/exoscale/cs. - Подробное руководство по модулям cloudstack можно найти в Руководстве по облаку CloudStack.
- Этот модуль поддерживает режим проверки.
Примеры
- name: Allow inbound port 80/tcp from 1.2.3.4 to 4.3.2.1
cs_firewall:
ip_address: 4.3.2.1
port: 80
cidr: 1.2.3.4/32
delegate_to: localhost
- name: Allow inbound tcp/udp port 53 to 4.3.2.1
cs_firewall:
ip_address: 4.3.2.1
port: 53
protocol: '{{ item }}'
with_items:
- tcp
- udp
delegate_to: localhost
- name: Ensure firewall rule is removed
cs_firewall:
ip_address: 4.3.2.1
start_port: 8000
end_port: 8888
cidr: 17.0.0.0/8
state: absent
delegate_to: localhost
- name: Allow all outbound traffic
cs_firewall:
network: my_network
type: egress
protocol: all
delegate_to: localhost
- name: Allow only HTTP outbound traffic for an IP
cs_firewall:
network: my_network
type: egress
port: 80
cidr: 10.101.1.20
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| cidr строка | успех | Строка CIDR правила. Пример: 0.0.0.0/0 |
| cidrs список добавлен в 2.5 | успех | Список CIDR правил. Пример: ['0.0.0.0/0'] |
| end_port целое число | успех | Конечный порт правила. Пример: 80 |
| icmp_code целое число | успех | Код ICMP правила. Пример: 1 |
| icmp_type целое число | успех | Тип ICMP правила. Пример: 1 |
| id строка | успех | UUID правила. Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6 |
| ip_address строка | успех | IP-адрес правила, если type=ingress
Пример: 10.100.212.10 |
| network строка | успех | Название сети, если type=egress
Пример: my_network |
| protocol строка | успех | Протокол правила. Пример: tcp |
| start_port целое число | успех | Начальный порт правила. Пример: 80 |
| type строка | успех | Тип правила. Пример: ingress |
Статус
- В этом модуле гарантируется отсутствие обратной несовместимости в будущих изменениях. [stableinterface]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- René Moser (@resmo)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/cs_firewall_module.html