Spec-Zone.ru › Ansible 2.5

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

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

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

Описание

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

Требования

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

  • python >= 2.6
  • cs >= 0.6.10

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
account Значение по умолчанию:
None
Аккаунт, к которому относится 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 Значение по умолчанию:
None
Домен, к которому относится VPC.
end_port Значение по умолчанию:
None
Конечный порт для этого правила.
Рассматривается, если protocol=tcp или protocol=udp.
Если не указано, равно start_port.
icmp_code Значение по умолчанию:
None
Код ошибки для этого сообщения ICMP.
Рассматривается, если protocol=icmp.
icmp_type Значение по умолчанию:
None
Тип сообщения ICMP.
Рассматривается, если protocol=icmp.
network_acl
обязательно
Имя списка управления доступом к сети.

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

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

псевдонимы: port
state
    Варианты:
  • present ←
  • absent
Состояние правила списка управления доступом к сети.
tags Значение по умолчанию:
None
Список тегов. Теги — список словарей, имеющих ключи key и value.
Для удаления всех тегов установите пустой список, например, tags: [].

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

псевдонимы: type
vpc
обязательно
VPC, к которому относится список управления доступом к сети.
zone Значение по умолчанию:
None
Имя зоны, к которой относится 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


Статус

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

Автор

  • 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_network_acl_rule_module.html

Spec-Zone.ru

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