cs_securitygroup_rule — Управляет правилами группы безопасности в облаках на базе Apache CloudStack.
Новое в версии 2.0.
Обзор
- Добавление и удаление правил группы безопасности.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- cs >= 0.6.10
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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, см. также раздел Примечания. | |
| cidr | Значение по умолчанию: 0.0.0.0/0 | CIDR (полная запись) для правила группы безопасности. |
| end_port | Конечный порт для правила. Требуется, если protocol=tcp или protocol=udp, но start_port будет использоваться, если не задано. | |
| icmp_code | Код ошибки для этого сообщения icmp. Требуется, если protocol=icmp. | |
| icmp_type | Тип сообщения icmp. Требуется, если protocol=icmp. | |
| poll_async | Значение по умолчанию: да | Ожидать завершения асинхронных задач. |
| project | Имя проекта, в котором будет создана группа безопасности. | |
| protocol |
| Протокол правила группы безопасности. |
| security_group обязательно | Имя группы безопасности, к которой относится правило. Группа безопасности должна существовать. | |
| start_port | Начальный порт для правила. Требуется, если protocol=tcp или protocol=udp. псевдонимы: порт | |
| state |
| Состояние правила группы безопасности. |
| type |
| Входящее или исходящее правило группы безопасности. |
| user_security_group | Группа безопасности, на основе которой создается это правило. |
Примечания
Примечание
- 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 added to security group 'default'
local_action:
module: cs_securitygroup_rule
security_group: default
port: 80
cidr: 1.2.3.4/32
- name: allow tcp/udp outbound added to security group 'default'
local_action:
module: cs_securitygroup_rule
security_group: default
type: egress
start_port: 1
end_port: 65535
protocol: '{{ item }}'
with_items:
- tcp
- udp
- name: allow inbound icmp from 0.0.0.0/0 added to security group 'default'
local_action:
module: cs_securitygroup_rule
security_group: default
protocol: icmp
icmp_code: -1
icmp_type: -1
- name: remove rule inbound port 80/tcp from 0.0.0.0/0 from security group 'default'
local_action:
module: cs_securitygroup_rule
security_group: default
port: 80
state: absent
- name: allow inbound port 80/tcp from security group web added to security group 'default'
local_action:
module: cs_securitygroup_rule
security_group: default
port: 80
user_security_group: web
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| cidr строка | успех и cidr определен | CIDR правила. Пример: 0.0.0.0/0 |
| end_port целое число | успех | Конечный порт правила. Пример: 80 |
| id строка | успех | UUID правила. Пример: a6f7a5fc-43f8-11e5-a151-feff819cdc9f |
| protocol строка | успех | Протокол правила. Пример: tcp |
| security_group строка | успех | Группа безопасности правила. Пример: default |
| start_port целое число | успех | Начальный порт правила. Пример: 80 |
| type строка | успех | Тип правила. Пример: ingress |
| user_security_group строка | успех и user_security_group определен | Пользовательская группа безопасности правила. Пример: default |
Статус
Этот модуль помечен как 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_securitygroup_rule_module.html