amazon.aws.ec2_security_group_info 模块 – 收集 AWS 中 EC2 安全组信息

注意

此模块是 amazon.aws 集合 (版本 9.0.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装它，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install amazon.aws。您需要其他要求才能使用此模块，有关详细信息，请参阅需求。

要在 playbook 中使用它，请指定： amazon.aws.ec2_security_group_info。

amazon.aws 1.0.0 中的新增功能

概要 

收集有关 AWS 中 EC2 安全组的信息。

别名：ec2_group_info

需求 

在执行此模块的主机上需要以下需求。

python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0

参数 

参数	注释
access_key 别名：aws_access_key_id, aws_access_key, ec2_access_key 字符串	AWS 访问密钥 ID。有关访问令牌的更多信息，请参见 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 botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已被弃用，并将在 2024-12-01 之后的发行版本中移除。 `EC2_ACCESS_KEY` 环境变量的支持已被弃用，并将在 2024-12-01 之后的发行版本中移除。
aws_ca_bundle 路径	验证 SSL 证书时要使用的 CA 捆绑包的位置。也可以使用 `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` 回调将输出到 playbook 期间进行的总列表。也可以使用 `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 版本中添加，以与 AWS botocore SDK 保持一致。别名 ec2_secret_key 已弃用，并将在 2024-12-01 之后的一个版本中移除。对环境变量 `EC2_SECRET_KEY` 的支持已弃用，并将在 2024-12-01 之后的一个版本中移除。
session_token 别名：aws_session_token, security_token, aws_security_token, access_token 字符串	用于临时凭证的 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`、`AWS_SECURITY_TOKEN` 或 `EC2_SECURITY_TOKEN`，优先级依次递减。 security_token 和 profile 选项互斥。别名 aws_session_token 和 session_token 在 3.2.0 版本中添加，参数名称在 6.0.0 版本中从 security_token 重命名为 session_token。别名 security_token、aws_security_token 和 access_token 已弃用，并将在 2024-12-01 之后的一个版本中移除。对环境变量 `EC2_SECRET_KEY` 和 `AWS_SECURITY_TOKEN` 的支持已弃用，并将在 2024-12-01 之后的一个版本中移除。
validate_certs 布尔值	设置为 `false` 时，将不会验证与 AWS API 通信的 SSL 证书。强烈建议不要设置 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 列表 / 元素=字典	与提供的过滤器匹配的安全组。每个元素包含一个字典，其中包含与该安全组相关的所有信息。返回值：始终示例： `[{"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 字符串	安全组的描述。返回值：始终
group_id 字符串	安全组的 ID。返回值：始终
group_name 字符串	安全组的名称。返回值：始终
ip_permissions 列表 / 元素=字典	与安全组关联的入站规则。返回值：始终
from_port 整数	如果协议是 TCP 或 UDP，则这是端口范围的起始值。返回值：成功示例： `80`
ip_protocol 字符串	IP 协议名称或编号。返回值：始终
ip_ranges 列表 / 元素=字典	IPv4 范围。返回值：始终
cidr_ip 字符串	IPv4 CIDR 范围。返回值：始终
ipv6_ranges 列表 / 元素=字典	IPv6 范围。返回值：始终
cidr_ipv6 字符串	IPv6 CIDR 范围。返回值：始终
prefix_list_ids 列表 / 元素=字典	前缀列表 ID。返回值：始终
prefix_list_id 字符串	前缀的 ID。返回值：始终
to_group 整数	如果协议是 TCP 或 UDP，则这是端口范围的结束值。返回值：成功示例： `80`
user_id_group_pairs 列表 / 元素=字典	安全组和 AWS 账户 ID 对。返回值：始终
group_id 字符串	对的安全组 ID。返回值：始终
user_id 字符串	对的用户 ID。返回值：始终
ip_permissions_egress 列表 / 元素=字典	与安全组关联的出站规则。返回值：始终
ip_protocol 字符串	IP 协议名称或编号。返回值：始终
ip_ranges 列表 / 元素=字典	IPv4 范围。返回值：始终
cidr_ip 字符串	IPv4 CIDR 范围。返回值：始终
ipv6_ranges 列表 / 元素=字典	IPv6 范围。返回值：始终
cidr_ipv6 字符串	IPv6 CIDR 范围。返回值：始终
prefix_list_ids 列表 / 元素=字典	前缀列表 ID。返回值：始终
prefix_list_id 字符串	前缀的 ID。返回值：始终
user_id_group_pairs 列表 / 元素=字典	安全组和 AWS 账户 ID 对。返回值：始终
group_id 字符串	对的安全组 ID。返回值：始终
user_id 字符串	对的用户 ID。返回值：始终
owner_id 字符串	安全组所有者的 AWS 账户 ID。返回值：始终
tags 字典	与安全组关联的标签。返回值：始终
vpc_id 字符串	安全组的 VPC ID。返回值：始终

作者

Henrique Rodrigues (@Sodki)