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. псевдонимы: порт | |
| state |
| Состояние правила брандмауэра. |
| tags (добавлено в 2.4) | Список тегов. Теги — список словарей с ключами key и value. Для удаления всех тегов установите пустой список, например, tags: []. псевдонимы: тег | |
| 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
local_action:
module: cs_firewall
ip_address: 4.3.2.1
port: 80
cidr: 1.2.3.4/32
- name: Allow inbound tcp/udp port 53 to 4.3.2.1
local_action:
module: cs_firewall
ip_address: 4.3.2.1
port: 53
protocol: '{{ item }}'
with_items:
- tcp
- udp
- name: Ensure firewall rule is removed
local_action:
module: cs_firewall
ip_address: 4.3.2.1
start_port: 8000
end_port: 8888
cidr: 17.0.0.0/8
state: absent
- name: Allow all outbound traffic
local_action:
module: cs_firewall
network: my_network
type: egress
protocol: all
- name: Allow only HTTP outbound traffic for an IP
local_action:
module: cs_firewall
network: my_network
type: egress
port: 80
cidr: 10.101.1.20
Значения возврата
Общие значения возврата описаны в здесь, ниже указаны поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| cidr строка | успешно | Строка CIDR правила. Пример: 0.0.0.0/0 |
| cidrs список | успешно | Список 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, что означает, что разработчики этого модуля гарантируют, что не будут вноситься несовместимые изменения в интерфейс.
Автор
- 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.5/modules/cs_firewall_module.html