Spec-Zone.ru › Ansible 2.11

community.aws.ec2_vpc_nacl – создание и удаление сетевых ACL.

Примечание

Этот плагин является частью коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Чтобы использовать его в книге задач, укажите: community.aws.ec2_vpc_nacl.

Новое в версии 1.0.0: коллекции community.aws

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

Обзор

  • Прочитайте документацию AWS по сетевым ACL https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html

Требования

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

  • boto
  • boto3
  • botocore
  • json
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key
строка
Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.
Если параметр profile задан, этот параметр игнорируется.
Одновременное указание параметров aws_access_key и profile устарело и будет сделано взаимоисключающими после 2022-06-01.

псевдонимы: ec2_access_key, access_key
aws_ca_bundle
путь
Расположение набора сертификатов CA для проверки SSL-сертификатов.
Используется только для модулей на основе boto3.
Примечание: набор CA считывается со стороны модуля и, возможно, должен быть явно скопирован с контроллера, если он не запускается локально.
aws_config
словарь
Словарь для изменения конфигурации botocore.
Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для дополнительной конфигурации boto.
aws_secret_key
строка
Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.
Если параметр profile задан, этот параметр игнорируется.
Одновременное указание параметров aws_secret_key и profile устарело и будет сделано взаимоисключающими после 2022-06-01.

псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
логический тип
    Варианты:
  • нет ←
  • да
Используйте логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполненных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в полный список, сделанный во время книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
ec2_url
строка
URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если таковая имеется.

псевдонимы: aws_endpoint_url, endpoint_url
egress
список / элементы=список
По умолчанию:
[]
Список правил для исходящего трафика. Каждое правило должно быть указано как список. Каждое правило может содержать номер правила (целое число от 1 до 32766), протокол (один из ['tcp', 'udp', 'icmp', '-1', 'all']), действие правила ('разрешить' или 'запретить'), CIDR диапазона IPv4 сети для разрешения или запрета, тип ICMP (-1 означает все типы), код ICMP (-1 означает все коды), последний порт в диапазоне для протоколов TCP или UDP и первый порт в диапазоне для протоколов TCP или UDP. Смотрите примеры.
ingress
список / элементы=список
По умолчанию:
[]
Список правил для входящего трафика. Каждое правило должно быть указано как список. Каждое правило может содержать номер правила (целое число от 1 до 32766), протокол (один из ['tcp', 'udp', 'icmp', '-1', 'all']), действие правила ('разрешить' или 'запретить'), CIDR диапазона IPv4 сети для разрешения или запрета, тип ICMP (-1 означает все типы), код ICMP (-1 означает все коды), последний порт в диапазоне для протоколов TCP или UDP и первый порт в диапазоне для протоколов TCP или UDP. Смотрите примеры.
nacl_id
строка
Идентификатор NACL, определяющий сетевой ACL.
Требуется и только один из параметров name или nacl_id.
name
строка
Имя тега, определяющее сетевой ACL.
Требуется и только один из параметров name или nacl_id.
profile
строка
Использует профиль boto. Работает только с boto >= 2.24.0.
Использование profile переопределяет aws_access_key, aws_secret_key и security_token, а поддержка одновременного указания их с profile устарела.
aws_access_key, aws_secret_key и security_token будут взаимоисключающими с profile после 2022-06-01.

псевдонимы: aws_profile
region
строка
AWS-регион для использования. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION, если таковая имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

псевдонимы: aws_region, ec2_region
security_token
строка
Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
Если параметр profile задан, этот параметр игнорируется.
Одновременное указание параметров security_token и profile устарело и будет сделано взаимоисключающими после 2022-06-01.

псевдонимы: aws_security_token, access_token
state
строка
    Варианты:
  • present ←
  • absent
Создает или изменяет существующий NACL
Удаляет NACL и повторно связывает подсети с NACL по умолчанию
subnets
список / элементы=строка
Список подсетей, которые должны быть связаны с сетевым ACL.
Должен быть указан как список
Каждая подсеть может быть указана как идентификатор подсети или ее имя тега.
tags
словарь
Словарь тегов для поиска и применения при создании сетевого ACL.
validate_certs
логический тип
    Варианты:
  • нет
  • да ←
При значении «нет» SSL-сертификаты не будут проверяться для версий boto >= 2.6.0.
vpc_id
строка
Идентификатор VPC запрашиваемой VPC.
Обязательно при state present.

Примечания

Примечание

  • Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY или EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY или EC2_SECRET_KEY, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN, AWS_REGION или EC2_REGION, AWS_CA_BUNDLE
  • Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION или EC2_REGION обычно используются для указания AWS-региона, когда это требуется, но это также можно настроить в конфигурационном файле boto.

Примеры

# Complete example to create and delete a network ACL
# that allows SSH, HTTP and ICMP in, and all traffic out.
- name: "Create and associate production DMZ network ACL with DMZ subnets"
  community.aws.ec2_vpc_nacl:
    vpc_id: vpc-12345678
    name: prod-dmz-nacl
    region: ap-southeast-2
    subnets: ['prod-dmz-1', 'prod-dmz-2']
    tags:
      CostCode: CC1234
      Project: phoenix
      Description: production DMZ
    ingress:
        # rule no, protocol, allow/deny, cidr, icmp_type, icmp_code,
        #                                             port from, port to
        - [100, 'tcp', 'allow', '0.0.0.0/0', null, null, 22, 22]
        - [200, 'tcp', 'allow', '0.0.0.0/0', null, null, 80, 80]
        - [300, 'icmp', 'allow', '0.0.0.0/0', 0, 8]
    egress:
        - [100, 'all', 'allow', '0.0.0.0/0', null, null, null, null]
    state: 'present'

- name: "Remove the ingress and egress rules - defaults to deny all"
  community.aws.ec2_vpc_nacl:
    vpc_id: vpc-12345678
    name: prod-dmz-nacl
    region: ap-southeast-2
    subnets:
      - prod-dmz-1
      - prod-dmz-2
    tags:
      CostCode: CC1234
      Project: phoenix
      Description: production DMZ
    state: present

- name: "Remove the NACL subnet associations and tags"
  community.aws.ec2_vpc_nacl:
    vpc_id: 'vpc-12345678'
    name: prod-dmz-nacl
    region: ap-southeast-2
    state: present

- name: "Delete nacl and subnet associations"
  community.aws.ec2_vpc_nacl:
    vpc_id: vpc-12345678
    name: prod-dmz-nacl
    state: absent

- name: "Delete nacl by its id"
  community.aws.ec2_vpc_nacl:
    nacl_id: acl-33b4ee5b
    state: absent

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

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

Ключ Возвращаемое значение Описание
nacl_id
строка
успех
Идентификатор NACL (при создании или обновлении ACL)

Пример:
acl-123456789abcdef01
task
словарь
успех
Результат действия create или delete.



Авторы

  • Mike Mochan (@mmochan)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/ec2_vpc_nacl_module.html

Spec-Zone.ru

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