Spec-Zone.ru › Ansible

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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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.35.0
  • botocore >= 1.35.0

Параметры

Параметр

Комментарии

access_key

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

string

Идентификатор ключа доступа 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 в порядке убывания предпочтения.

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

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK.

aws_ca_bundle

path

Путь к пакету сертификатов CA, который используется для проверки SSL-сертификатов.

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

aws_config

dictionary

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

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

debug_botocore_endpoint_logs

boolean

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

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

Варианты:

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

endpoint_url

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

string

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

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

filters

dictionary

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

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

profile

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

string

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

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

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

Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token.

region

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

string

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

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

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

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

secret_key

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

string

Секретный ключ доступа 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 в порядке убывания предпочтения.

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

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK.

session_token

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

string

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

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

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

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

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, а не из контекста «хоста».
  • Используемый Ansible AWS SDK (boto3) также может считывать значения учётных данных и других параметров, например региона, по умолчанию из файлов конфигурации в контексте «хоста» 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

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

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

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

user_id_group_pairs

list / elements=dictionary

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

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

group_id

string

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

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

user_id

string

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

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

owner_id

string

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

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

tags

dictionary

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

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

vpc_id

string

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

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

Авторы

  • Henrique Rodrigues (@Sodki)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Связь

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

Spec-Zone.ru

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