Spec-Zone.ru › Ansible 2.6

cs_network_acl_rule — Управляет правилами списка управления доступом к сети (ACL) в облаках на основе Apache CloudStack.

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

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

Обзор

  • Добавление, обновление и удаление правил списка управления доступом к сети.

Требования

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

  • python >= 2.6
  • cs >= 0.6.10

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
account
Аккаунт, к которому относится VPC.
action_policy
    Варианты:
  • allow
  • deny
Значение по умолчанию:
"ingress"
Политика действия правила.

псевдонимы: action
api_http_method
    Варианты:
  • get
  • post
HTTP-метод, используемый для запроса к API-точке.
Если не указано, используется переменная среды CLOUDSTACK_METHOD.
В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
Значение по умолчанию — get, если не указано.
api_key
API-ключ API CloudStack.
Если не указано, используется переменная среды CLOUDSTACK_KEY.
В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
api_region Значение по умолчанию:
"cloudstack"
Имя раздела ini в файле cloustack.ini.
Если не указано, используется переменная среды CLOUDSTACK_REGION.
api_secret
Секретный ключ API CloudStack.
Если не задано, используется переменная среды CLOUDSTACK_SECRET.
В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
api_timeout
Таймаут HTTP в секундах.
Если не указано, используется переменная среды CLOUDSTACK_TIMEOUT.
В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
Значение по умолчанию — 10 секунд, если не указано.
api_url
URL API CloudStack, например, https://cloud.example.com/client/api.
Если не указано, используется переменная среды CLOUDSTACK_ENDPOINT.
В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания.
cidr Значение по умолчанию:
"0.0.0.0/0"
CIDR правила.
domain
Домен, к которому относится VPC.
end_port
Конечный порт для этого правила.
Рассматривается, если protocol=tcp или protocol=udp.
Если не указано, равно start_port.
icmp_code
Код ошибки для этого сообщения ICMP.
Рассматривается, если protocol=icmp.
icmp_type
Тип сообщения ICMP, которое отправляется.
Рассматривается, если protocol=icmp.
network_acl
обязательно
Имя списка управления доступом к сети.

псевдонимы: acl
poll_async
bool
    Варианты:
  • no
  • да ←
Проверить асинхронные задачи, пока задача не завершится.
project
Имя проекта, к которому относится VPC.
protocol
    Варианты:
  • tcp ←
  • udp
  • icmp
  • all
  • by_number
Протокол правила.
protocol_number
Номер протокола от 1 до 256, требуется, если protocol=by_number.
rule_position
обязательно
CIDR правила.

псевдонимы: number
start_port
Начальный порт для этого правила.
Рассматривается, если protocol=tcp или protocol=udp.

псевдонимы: порт
state
    Варианты:
  • present ←
  • absent
Состояние правила списка управления доступом к сети.
tags
Список тегов. Теги — список словарей с ключами key и value.
Если нужно удалить все теги, задайте пустой список, например, tags: [].

псевдонимы: tag
traffic_type
    Варианты:
  • ingress ←
  • egress
Тип трафика правила.

псевдонимы: тип
vpc
обязательно
VPC, к которому относится список управления доступом к сети.
zone
Имя зоны, к которой относится VPC.
Если не указано, используется зона по умолчанию.

Примечания

Примечание

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

Примеры

# create a network ACL rule, allow port 80 ingress
- local_action:
    module: cs_network_acl_rule
    network_acl: web
    rule_position: 1
    vpc: my vpc
    traffic_type: ingress
    action_policy: allow
    port: 80
    cidr: 0.0.0.0/0

# create a network ACL rule, deny port range 8000-9000 ingress for 10.20.0.0/16
- local_action:
    module: cs_network_acl_rule
    network_acl: web
    rule_position: 1
    vpc: my vpc
    traffic_type: ingress
    action_policy: deny
    start_port: 8000
    end_port: 8000
    cidr: 10.20.0.0/16

# create a network ACL rule
- local_action:
    module: cs_network_acl_rule
    network_acl: web
    rule_position: 1
    vpc: my vpc
    traffic_type: ingress
    action_policy: deny
    start_port: 8000
    end_port: 8000
    cidr: 10.20.0.0/16

# remove a network ACL rule
- local_action:
    module: cs_network_acl_rule
    network_acl: web
    rule_position: 1
    vpc: my vpc
    state: absent

Возвращаемые значения

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

Ключ Возвращаемое значение Описание
account
строка
успех
Аккаунт, к которому относится правило сетевого списка ACL.

Пример:
example account
action_policy
строка
успех
Политика действия правила сетевого списка ACL.

Пример:
deny
cidr
строка
успех
CIDR правила сетевого списка ACL.

Пример:
0.0.0.0/0
domain
строка
успех
Домен, к которому относится правило сетевого списка ACL.

Пример:
example domain
end_port
целое число
успех
Конечный порт правила сетевого списка ACL.

Пример:
80
icmp_code
целое число
успех
Код ICMP правила сетевого списка ACL.

Пример:
8
icmp_type
целое число
успех
Тип ICMP правила сетевого списка ACL.

network_acl
строка
успех
Имя сетевого списка ACL.

Пример:
customer acl
project
строка
успех
Имя проекта, к которому относится правило сетевого списка ACL.

Пример:
Production
protocol
строка
успех
Протокол правила сетевого списка ACL.

Пример:
tcp
protocol_number
целое число
успех
Номер протокола, если протокол задаётся номером.

Пример:
8
rule_position
целое число
успех
Позиция правила сетевого списка ACL.

Пример:
1
start_port
целое число
успех
Начальный порт правила сетевого списка ACL.

Пример:
80
state
строка
успех
Состояние правила сетевого списка ACL.

Пример:
Активно
tags
словарь
успех
Список тегов ресурсов, связанных с правилом сетевого списка ACL.

Пример:
[ { "key": "foo", "value": "bar" } ]
traffic_type
строка
успех
Тип трафика правила сетевого списка ACL.

Пример:
входящий
vpc
строка
успех
VPC сетевого списка ACL.

Пример:
customer vpc
zone
строка
успех
Зона, к которой относится VPC.

Пример:
ch-gva-2


Статус

Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантированно будет обратной совместимостью.

Техническое обслуживание

Этот модуль помечен как общественный, что означает, что его поддерживает сообщество Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

  • 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.6/modules/cs_network_acl_rule_module.html

Spec-Zone.ru

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