community.aws.efs_info module – Get information about Amazon EFS file systems

Note

This module is part of the community.aws collection (version 10.1.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.aws. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.aws.efs_info.

New in community.aws 1.0.0

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

This module can be used to search Amazon EFS file systems. Note that the community.aws.efs_info module no longer returns ansible_facts!

Requirements

The below requirements are needed on the host that executes this module.

python >= 3.6
boto3 >= 1.34.0
botocore >= 1.34.0

Parameters

Parameter	Comments
access_key aliases: aws_access_key_id, aws_access_key string	AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The `AWS_ACCESS_KEY_ID` or `AWS_ACCESS_KEY` environment variables may also be used in decreasing order of preference. The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK.
aws_ca_bundle path	The location of a CA Bundle to use when validating SSL certificates. The `AWS_CA_BUNDLE` environment variable may also be used.
aws_config dictionary	A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs boolean	Use a `botocore.endpoint` logger to parse the unique (rather than total) `"resource:action"` API calls made during a task, outputing the set to the resource_actions key in the task results. Use the `aws_resource_action` callback to output to total list made during a playbook. The `ANSIBLE_DEBUG_BOTOCORE_LOGS` environment variable may also be used. Choices: `false` ← (default) `true`
endpoint_url aliases: aws_endpoint_url string	URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The `AWS_URL` environment variable may also be used.
id string	ID of Amazon EFS.
name aliases: creation_token string	Creation Token of Amazon EFS file system.
profile aliases: aws_profile string	A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The `AWS_PROFILE` environment variable may also be used. The profile option is mutually exclusive with the aws_access_key, aws_secret_key and session_token options.
region aliases: aws_region string	The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The `AWS_REGION` environment variable may also be used. See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
secret_key aliases: aws_secret_access_key, aws_secret_key string	AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The `AWS_SECRET_ACCESS_KEY` or `AWS_SECRET_KEY` environment variables may also be used in decreasing order of preference. The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK.
session_token aliases: aws_session_token string	AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The `AWS_SESSION_TOKEN` environment variable may also be used. The session_token and profile options are mutually exclusive.
tags dictionary	List of tags of Amazon EFS. Should be defined as dictionary. Default: `{}`
targets list / elements=string	List of targets on which to filter the returned results. Result must match all of the specified targets, each of which can be a security group ID, a subnet ID or an IP address. Default: `[]`
validate_certs boolean	When set to `false`, SSL certificates will not be validated for communication with the AWS APIs. Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices: `false` `true` ← (default)

Notes

Note

Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

Examples

- 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'] }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
creation_time string	timestamp of creation date Returned: always Sample: `"2015-11-16 07:30:57-05:00"`
creation_token string	EFS creation token Returned: always Sample: `"console-88609e04-9a0e-4a2e-912c-feaa99509961"`
file_system_id string	ID of the file system Returned: always Sample: `"fs-xxxxxxxx"`
filesystem_address string	url of file system Returned: always Sample: `"fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/"`
life_cycle_state string	state of the EFS file system Returned: always Sample: `"creating, available, deleting, deleted"`
mount_point string	url of file system with leading dot from the time AWS EFS required to add network suffix to EFS address Returned: always Sample: `".fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/"`
mount_targets list / elements=string	list of mount targets Returned: always Sample: `[{"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 string	name of the file system Returned: always Sample: `"my-efs"`
number_of_mount_targets integer	the number of targets mounted Returned: always Sample: `3`
owner_id string	AWS account ID of EFS owner Returned: always Sample: `"XXXXXXXXXXXX"`
performance_mode string	performance mode of the file system Returned: always Sample: `"generalPurpose"`
provisioned_throughput_in_mibps float	throughput provisioned in Mibps Returned: when throughput_mode is set to “provisioned” Sample: `15.0`
size_in_bytes dictionary	size of the file system in bytes as of a timestamp Returned: always Sample: `{"timestamp": "2015-12-21 13:59:59-05:00", "value": 12288}`
tags dictionary	tags on the efs instance Returned: always Sample: `{"key": "Value", "name": "my-efs"}`
throughput_mode string	mode of throughput for the file system Returned: always Sample: `"bursting"`

Authors

Ryan Sydnor (@ryansydnor)

Collection links

© 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/community/aws/efs_info_module.html