Spec-Zone.ru › Ansible

amazon.aws.ec2_security_group_info модуль — Сбор информации о группах безопасности EC2 в AWS

Примечание

Этот модуль является частью коллекции amazon.aws (версия 8.2.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Для использования в плейбуке укажите: amazon.aws.ec2_security_group_info.

Новое в amazon.aws 1.0.0

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

Обзор

  • Сбор информации о группах безопасности EC2 в AWS.

Псевдонимы: ec2_group_info

Требования

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

  • python >= 3.6
  • boto3 >= 1.26.0
  • botocore >= 1.29.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key

строка

Идентификатор ключа доступа AWS.

Дополнительную информацию об маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY в порядке убывания приоритета.

Опции aws_access_key и profile взаимоисключающие.

Псевдоним aws_access_key_id добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

aws_ca_bundle

путь

Расположение пакета CA для проверки сертификатов SSL.

Также можно использовать переменную среды AWS_CA_BUNDLE.

aws_config

словарь

Словарь для изменения конфигурации botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

логический

Использовать botocore.endpoint логгер для анализа уникальных (а не общих) "resource:action" вызовов API во время выполнения задачи, выводя набор в ключ resource_actions результатов задачи. Используйте aws_resource_action обратный вызов для вывода в общий список, созданный во время выполнения книги сценариев.

Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

  • false ← (по умолчанию)
  • true

endpoint_url

псевдонимы: ec2_url, aws_endpoint_url, s3_url

строка

URL для подключения вместо стандартных конечных точек AWS. Хотя это может использоваться для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws протестированы только с AWS.

Также можно использовать переменные среды AWS_URL или EC2_URL в порядке убывания приоритета.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

filters

словарь

Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html для возможных фильтров. Названия и значения фильтров чувствительны к регистру. Также можно использовать символ подчеркивания (_) вместо дефиса (-) в ключах фильтра, который будет иметь приоритет в случае конфликта.

По умолчанию: {}

profile

псевдонимы: aws_profile

строка

Используемый именованный профиль AWS для аутентификации.

Дополнительную информацию об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также можно использовать переменную среды AWS_PROFILE.

Опция profile взаимоисключающая с опциями aws_access_key, aws_secret_key и security_token.

region

псевдонимы: aws_region, ec2_region

строка

AWS регион для использования.

Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется.

Также можно использовать переменные среды AWS_REGION или EC2_REGION.

Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key

строка

Секретный ключ доступа AWS.

Дополнительную информацию об маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, или EC2_SECRET_KEY в порядке убывания приоритета.

Опции secret_key и profile взаимоисключающие.

Псевдоним aws_secret_access_key добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

Токен сессии AWS STS для использования с временными учетными данными.

См. документацию AWS для получения дополнительной информации об access токенах https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также могут быть использованы переменные среды AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

Параметры security_token и profile взаимоисключающие.

Алиасы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0.

Алиасы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

validate_certs

boolean

При установке в false, сертификаты SSL для связи с API AWS не будут проверены.

Установка validate_certs=false крайне не рекомендуется, как альтернатива, рассмотрите настройку aws_ca_bundle вместо этого.

Выбираемые значения:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • По умолчанию модуль вернет все группы безопасности в регионе. Для ограничения результатов используйте соответствующие фильтры.
  • До релиза 5.0.0 этот модуль назывался amazon.aws.ec2_group_info. Использование не изменилось.
  • Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не «контроллер». Таким образом, файлы могут потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не «хост».
  • AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно ~/.aws/credentials). См. https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html для получения дополнительной информации.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Gather information about all security groups
- amazon.aws.ec2_security_group_info:

# Gather information about all security groups in a specific VPC
- amazon.aws.ec2_security_group_info:
    filters:
      vpc-id: vpc-12345678

# Gather information about all security groups in a specific VPC
- amazon.aws.ec2_security_group_info:
    filters:
      vpc-id: vpc-12345678

# Gather information about a security group
- amazon.aws.ec2_security_group_info:
    filters:
      group-name: example-1

# Gather information about a security group by id
- amazon.aws.ec2_security_group_info:
    filters:
      group-id: sg-12345678

# Gather information about a security group with multiple filters, also mixing the use of underscores as filter keys
- amazon.aws.ec2_security_group_info:
    filters:
      group_id: sg-12345678
      vpc-id: vpc-12345678

# Gather information about various security groups
- amazon.aws.ec2_security_group_info:
    filters:
      group-name:
        - example-1
        - example-2
        - example-3

# Gather information about any security group with a tag key Name and value Example.
# The quotes around 'tag:name' are important because of the colon in the value
- amazon.aws.ec2_security_group_info:
    filters:
      "tag:Name": Example

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

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

Ключ

Описание

security_groups

list / elements=dictionary

Группы безопасности, соответствующие предоставленным фильтрам. Каждый элемент состоит из словаря со всей информацией, относящейся к этой группе безопасности.

Возвращается: всегда

Пример: [{"description": "created by rds_instance integration tests", "group_id": "sg-036496a610b79da88", "group_name": "ansible-test-89355088-unknown5c5f67f3ad09-sg-1", "ip_permissions": [], "ip_permissions_egress": [{"ip_protocol": "-1", "ip_ranges": [{"cidr_ip": "0.0.0.0/0"}], "ipv6_ranges": [], "prefix_list_ids": [], "user_id_group_pairs": []}], "owner_id": "123456789012", "tags": {}, "vpc_id": "vpc-0bc3bb03f97405435"}]

description

string

Описание группы безопасности.

Возвращается: всегда

group_id

string

Идентификатор группы безопасности.

Возвращается: всегда

group_name

string

Имя группы безопасности.

Возвращается: всегда

ip_permissions

list / elements=dictionary

Входящие правила, связанные с группой безопасности.

Возвращается: всегда

from_port

integer

Если протокол TCP или UDP, это начало диапазона портов.

Возвращается: успех

Пример: 80

ip_protocol

string

Имя или номер протокола IP.

Возвращается: всегда

ip_ranges

list / elements=dictionary

Диапазоны IPv4.

Возвращается: всегда

cidr_ip

string

Диапазон IPv4 CIDR.

Возвращается: всегда

ipv6_ranges

list / elements=dictionary

Диапазоны IPv6.

Возвращается: всегда

cidr_ipv6

string

Диапазон IPv6 CIDR.

Возвращается: всегда

prefix_list_ids

list / elements=dictionary

Идентификаторы списка префиксов.

Возвращается: всегда

prefix_list_id

string

Идентификатор префикса.

Возвращается: всегда

to_group

integer

Если протокол TCP или UDP, это конец диапазона портов.

Возвращается: успех

Пример: 80

user_id_group_pairs

list / elements=dictionary

Пары идентификаторов групп безопасности и учетных записей AWS.

Возвращается: всегда

group_id

string

Идентификатор группы безопасности пары.

Возвращается: всегда

user_id

string

Идентификатор пользователя пары.

Возвращается: всегда

ip_permissions_egress

list / elements=dictionary

Исходящие правила, связанные с группой безопасности.

Возвращается: всегда

ip_protocol

string

Имя или номер протокола IP.

Возвращается: всегда

ip_ranges

список / элементы=словарь

Диапазоны IPv4.

Возвращается: всегда

cidr_ip

строка

Диапазон IPv4 CIDR.

Возвращается: всегда

ipv6_ranges

список / элементы=словарь

Диапазоны IPv6.

Возвращается: всегда

cidr_ipv6

строка

Диапазон IPv6 CIDR.

Возвращается: всегда

prefix_list_ids

список / элементы=словарь

Идентификаторы списков префиксов.

Возвращается: всегда

prefix_list_id

строка

Идентификатор префикса.

Возвращается: всегда

user_id_group_pairs

список / элементы=словарь

Пары идентификаторов группы и AWS учетной записи.

Возвращается: всегда

group_id

строка

Идентификатор группы безопасности пары.

Возвращается: всегда

user_id

строка

Идентификатор пользователя пары.

Возвращается: всегда

owner_id

строка

Идентификатор AWS учетной записи владельца группы безопасности.

Возвращается: всегда

tags

словарь

Теги, связанные с группой безопасности.

Возвращается: всегда

vpc_id

строка

Идентификатор VPC для группы безопасности.

Возвращается: всегда

Авторы

  • Henrique Rodrigues (@Sodki)

Ссылки на коллекцию

  • Трекер проблем
  • Репозиторий (источники)
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/amazon/aws/ec2_security_group_info_module.html

Spec-Zone.ru

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