cs_securitygroup_rule – Управляет правилами групп безопасности в облаках на базе Apache CloudStack

Новая версия с 2.0.

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата
Статус

Описание

Добавление и удаление правил группы безопасности.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_http_method строка	Варианты: get post	HTTP-метод, используемый для запроса к конечному пункту API. Если не задано, используется значение переменной среды `CLOUDSTACK_METHOD`. В качестве последнего варианта значение берется из файла конфигурации ini, см. также примечания. Значение по умолчанию `get` если не указано.
api_key строка		Ключ API для CloudStack API. Если не задано, используется значение переменной среды `CLOUDSTACK_KEY`. В качестве последнего варианта значение берется из файла конфигурации ini, см. также примечания.
api_region строка	По умолчанию: "cloudstack"	Имя раздела в файле конфигурации `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 булево	Варианты: no да ←	Ожидание завершения асинхронных задач.
project строка		Имя проекта, в котором будет создаваться группа безопасности.
protocol строка	Варианты: tcp ← udp icmp ah esp gre	Протокол правила группы безопасности.
security_group строка / обязательно		Имя группы безопасности, к которой относится правило. Группа безопасности должна существовать.
start_port целое число		Начальный порт для этого правила. Требуется, если protocol=tcp или protocol=udp. псевдонимы: port
state строка	Варианты: present ← absent	Состояние правила группы безопасности.
type строка	Варианты: ingress ← egress	Входящее или исходящее правило группы безопасности.
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 CloudStack Cloud Guide.
Этот модуль поддерживает режим проверки.

Примеры

---
- name: allow inbound port 80/tcp from 1.2.3.4 added to security group 'default'
  cs_securitygroup_rule:
    security_group: default
    port: 80
    cidr: 1.2.3.4/32
  delegate_to: localhost

- name: allow tcp/udp outbound added to security group 'default'
  cs_securitygroup_rule:
    security_group: default
    type: egress
    start_port: 1
    end_port: 65535
    protocol: '{{ item }}'
  with_items:
  - tcp
  - udp
  delegate_to: localhost

- name: allow inbound icmp from 0.0.0.0/0 added to security group 'default'
  cs_securitygroup_rule:
    security_group: default
    protocol: icmp
    icmp_code: -1
    icmp_type: -1
  delegate_to: localhost

- name: remove rule inbound port 80/tcp from 0.0.0.0/0 from security group 'default'
  cs_securitygroup_rule:
    security_group: default
    port: 80
    state: absent
  delegate_to: localhost

- name: allow inbound port 80/tcp from security group web added to security group 'default'
  cs_securitygroup_rule:
    security_group: default
    port: 80
    user_security_group: web
  delegate_to: localhost

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
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]
Этот модуль поддерживается сообществом 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_securitygroup_rule_module.html