Spec-Zone.ru › Ansible 2.9

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

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

Обзор

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

Требования

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

  • 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.
  • Этот модуль поддерживает режим проверки.

Примеры

---
- 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.9/modules/cs_securitygroup_rule_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API