amazon.aws.ec2_vpc_nacl_info 模块 – 收集有关 AWS VPC 中网络 ACL 的信息

注意

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

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

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

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

community.aws 1.0.0 中的新增功能

概要

  • 收集有关 AWS VPC 中网络 ACL 的信息。

要求

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

  • 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_access_key_id 别名在 5.1.0 版本中添加，与 AWS botocore SDK 保持一致。

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

字符串

连接到而不是默认 AWS 端点的 URL。虽然这可以用于连接到其他 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_DescribeNetworkAcls.html。过滤器名称和值区分大小写。

默认值： {}

nacl_ids

别名：nacl_id

列表 / 元素=字符串

要检索信息的网络 ACL ID 列表。

默认值: []

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 secret access key。

有关访问令牌的更多信息，请参阅 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 ← (默认)

注意

注意

  • 默认情况下，该模块将返回所有网络 ACL。

  • 注意：对于模块，环境变量和配置文件是从 Ansible “host” 上下文而不是 “controller” 上下文读取的。因此，可能需要将文件显式复制到 “host”。对于查找和连接插件，环境变量和配置文件是从 Ansible “controller” 上下文而不是 “host” 上下文读取的。

  • Ansible 使用的 AWS SDK (boto3) 也可能从 Ansible “host” 上下文中的配置文件（通常为 ~/.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 Network ACLs:
- name: Get All NACLs
  amazon.aws.ec2_vpc_nacl_info:
    region: us-west-2
  register: all_nacls

# Retrieve default Network ACLs:
- name: Get Default NACLs
  amazon.aws.ec2_vpc_nacl_info:
    region: us-west-2
    filters:
      'default': 'true'
  register: default_nacls

返回值

通用返回值记录在 此处，以下是此模块独有的字段

键

描述

nacls

复杂

返回如下所述的复杂对象数组。

返回: 成功

egress

列表 / 元素=列表

NACL 出站规则列表。

规则格式为 [规则编号，协议，允许/拒绝，v4 或 v6 cidr，icmp_type，icmp_code，端口起始，端口结束]。

返回: 始终

示例: [[100, "all", "allow", "0.0.0.0/0", null, null, null, null]]

ingress

列表 / 元素=列表

NACL 入站规则列表。

规则格式为 [规则编号，协议，允许/拒绝，v4 或 v6 cidr，icmp_type，icmp_code，端口起始，端口结束]。

返回: 始终

示例: [[100, "tcp", "allow", "0.0.0.0/0", null, null, 22, 22]]

is_default

布尔值

如果 NACL 是其 VPC 的默认值，则为 True。

返回: 始终

nacl_id

字符串

网络访问控制列表的 ID。

返回: 始终

subnets

列表 / 元素=字符串

与 NACL 关联的子网 ID 列表。

返回: 始终

tags

字典

与 NACL 关联的标签字典。

返回: 始终

vpc_id

字符串

NACL 所附加到的 VPC 的 ID。

返回: 始终

作者

  • Brad Davidson (@brandond)