community.aws.efs_info 模块 – 获取 Amazon EFS 文件系统信息

注意

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

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

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

要在 playbook 中使用它，请指定：community.aws.efs_info。

community.aws 1.0.0 中的新增功能

概要

• 此模块可用于搜索 Amazon EFS 文件系统。请注意，community.aws.efs_info 模块不再返回 ansible_facts！

要求

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

• 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 字符串	连接到非默认 AWS 端点的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。 也可以按优先级递减的顺序使用 AWS_URL 或 EC2_URL 环境变量。 ec2_url 和 s3_url 别名已弃用，并将在 2024-12-01 后的某个版本中删除。 EC2_URL 环境变量的支持已弃用，并将在 2024-12-01 后的某个版本中删除。
id 字符串	Amazon EFS 的 ID。
name 别名：creation_token 字符串	Amazon EFS 文件系统的创建令牌。
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 botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。 别名 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 之后的发行版中移除。
tags 字典	Amazon EFS 的标签列表。应定义为字典。 默认值： {}
targets 列表 / 元素=字符串	用于过滤返回结果的目标列表。 结果必须与所有指定的目标匹配，每个目标可以是安全组 ID、子网 ID 或 IP 地址。 默认值： []
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)

备注

注意

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

• Ansible 使用的 AWS SDK (boto3) 也可能从 Ansible“主机”上下文中的配置文件（通常为 ~/.aws/credentials）读取凭据和其他设置（例如区域）的默认值。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

- name: Find all existing efs
  community.aws.efs_info:
  register: result

- name: Find efs using id
  community.aws.efs_info:
    id: fs-1234abcd
  register: result

- name: Searching all EFS instances with tag Name = 'myTestNameTag', in subnet 'subnet-1a2b3c4d' and with security group 'sg-4d3c2b1a'
  community.aws.efs_info:
    tags:
      Name: myTestNameTag
    targets:
      - subnet-1a2b3c4d
      - sg-4d3c2b1a
  register: result

- ansible.builtin.debug:
    msg: "{{ result['efs'] }}"

返回值

公共返回值已记录在 此处，以下是此模块独有的字段

键	描述
creation_time 字符串	创建时间戳 返回：始终 示例： "2015-11-16 07:30:57-05:00"
creation_token 字符串	EFS 创建令牌 返回：始终 示例： "console-88609e04-9a0e-4a2e-912c-feaa99509961"
file_system_id 字符串	文件系统的 ID 返回：始终 示例： "fs-xxxxxxxx"
filesystem_address 字符串	文件系统的 URL 返回：始终 示例： "fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/"
life_cycle_state 字符串	EFS 文件系统状态 返回：始终 示例： "creating, available, deleting, deleted"
mount_point 字符串	从 AWS EFS 需要向 EFS 地址添加网络后缀的时间开始，带有前导点的文件系统 URL 返回：始终 示例： ".fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/"
mount_targets 列表 / 元素=字符串	挂载目标列表 返回：始终 示例： [{"file_system_id": "fs-a7ad440e", "ip_address": "172.31.17.173", "life_cycle_state": "available", "mount_target_id": "fsmt-d8907871", "network_interface_id": "eni-6e387e26", "owner_id": "123456789012", "security_groups": ["sg-a30b22c6"], "subnet_id": "subnet-e265c895"}, "..."]
name 字符串	文件系统的名称 返回：始终 示例： "my-efs"
number_of_mount_targets 整数	已挂载的目标数量 返回：始终 示例： 3
owner_id 字符串	EFS 所有者的 AWS 账户 ID 返回：始终 示例： "XXXXXXXXXXXX"
performance_mode 字符串	文件系统的性能模式 返回：始终 示例： "generalPurpose"
provisioned_throughput_in_mibps 浮点数	以 Mibps 为单位配置的吞吐量 返回：当 throughput_mode 设置为“provisioned”时 示例： 15.0
size_in_bytes 字典	截至时间戳的文件系统大小（以字节为单位） 返回：始终 示例： {"timestamp": "2015-12-21 13:59:59-05:00", "value": 12288}
tags 字典	efs 实例上的标签 返回：始终 示例： {"key": "Value", "name": "my-efs"}
throughput_mode 字符串	文件系统的吞吐量模式 返回：始终 示例： "bursting"

作者

• Ryan Sydnor (@ryansydnor)

集合链接

• 问题追踪器
• 代码库（源代码）
• 沟通