community.aws.storagegateway_info 模块 – 获取 AWS Storage Gateway 信息

注意

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

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

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

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

community.aws 1.0.0 中的新增功能

概要

• 获取 AWS Storage Gateway 信息

• 在 5.0.0 版本之前，此模块名为 community.aws.aws_sgw_info。用法没有改变。

别名：aws_sgw_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 之后的版本中删除。
gather_file_shares 布尔值	收集 S3 模式下存储网关的文件共享信息。 选择 false true ← (默认)
gather_local_disks 布尔值	收集连接到存储网关的本地磁盘。 选择 false true ← (默认)
gather_tapes 布尔值	收集磁带模式下存储网关的磁带信息。 选择 false true ← (默认)
gather_volumes 布尔值	收集 iSCSI（缓存和存储）模式下存储网关的卷信息。 选择 false true ← (默认)
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 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 之后的版本中删除。
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。

示例

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

- name: "Get AWS storage gateway information"
  community.aws.storagegateway_info:

- name: "Get AWS storage gateway information for region eu-west-3"
  community.aws.storagegateway_info:
    region: eu-west-3

返回值

常见的返回值记录在 此处，以下是此模块特有的字段

键	描述
gateways 复杂	网关对象列表 返回： 始终
file_shares 复杂	存储网关文件共享 返回： 当 gateway_type == “FILE_S3” 时
file_share_arn 字符串	文件共享 ARN 返回： 始终 示例： "arn:aws:storagegateway:eu-west-1:123456789012:share/share-AF999C88"
file_share_id 字符串	文件共享 ID 返回： 始终 示例： "share-AF999C88"
file_share_status 字符串	文件共享状态 返回： 始终 示例： "AVAILABLE"
gateway_arn 字符串	存储网关 ARN 返回： 始终 示例： "arn:aws:storagegateway:eu-west-1:123456789012:gateway/sgw-9999F888"
gateway_id 字符串	存储网关 ID 返回： 始终 示例： "sgw-9999F888"
gateway_name 字符串	存储网关友好名称 返回： 始终 示例： "my-sgw-01"
gateway_operational_state 字符串	存储网关运行状态 返回： 始终 示例： "ACTIVE"
gateway_type 字符串	存储网关类型 返回： 始终 示例： "FILE_S3"
local_disks 复杂	存储网关本地磁盘 返回： 始终
disk_allocation_type 字符串	磁盘分配类型 返回： 始终 示例： "CACHE STORAGE"
disk_id 字符串	系统上的磁盘 ID 返回： 始终 示例： "pci-0000:00:1f.0"
disk_node 字符串	磁盘父块设备 返回： 始终 示例： "/dev/sdb"
disk_path 字符串	用于缓存的磁盘路径 返回： 始终 示例： "/dev/nvme1n1"
disk_size_in_bytes 整数	磁盘大小（以字节为单位） 返回： 始终 示例： 107374182400
disk_status 字符串	磁盘状态 返回： 始终 示例： "present"
tapes 复杂	存储网关磁带 返回： 当 gateway_type == “VTL” 时
tape_arn 字符串	磁带 ARN 返回： 始终 示例： "arn:aws:storagegateway:eu-west-1:123456789012:tape/tape-AF999C88"
tape_barcode 字符串	磁带 ARN 返回： 始终 示例： "tape-AF999C88"
tape_size_in_bytes 整数	磁带 ARN 返回： 始终 示例： 555887569
tape_status 字符串	磁带 ARN 返回： 始终 示例： "AVAILABLE"

作者

• Loic Blot (@nerzhul)

合集链接

• 问题跟踪器
• 存储库（源代码）
• 沟通