efs_facts - Get information about Amazon EFS file systems

New in version 2.2.

Synopsis

Requirements

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

  • boto
  • boto3
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
aws_access_key
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.

aliases: ec2_access_key, access_key
aws_secret_key
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.

aliases: ec2_secret_key, secret_key
ec2_url
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
id
ID of Amazon EFS.
name
Creation Token of Amazon EFS file system.
profile
(added in 1.6)
Uses a boto profile. Only works with boto >= 2.24.0.
region
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

aliases: aws_region, ec2_region
security_token
(added in 1.6)
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.

aliases: access_token
tags
List of tags of Amazon EFS. Should be defined as dictionary
targets
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
validate_certs
bool

(added in 1.5)
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples

# find all existing efs
- efs_facts:
  register: result

- efs_facts:
    name: myTestNameTag

- efs_facts:
    id: fs-1234abcd

# Searching all EFS instances with tag Name = 'myTestNameTag', in subnet 'subnet-1a2b3c4d' and with security group 'sg-4d3c2b1a'
- efs_facts:
    tags:
        name: myTestNameTag
    targets:
        - subnet-1a2b3c4d
        - sg-4d3c2b1a

Return Values

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

Key Returned Description
creation_time
str
 always
timestamp of creation date

Sample:
2015-11-16 07:30:57-05:00
creation_token
str
 always
EFS creation token

Sample:
console-88609e04-9a0e-4a2e-912c-feaa99509961
file_system_id
str
 always
ID of the file system

Sample:
fs-xxxxxxxx
filesystem_address
str
 always
url of file system

Sample:
fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/
life_cycle_state
str
 always
state of the EFS file system

Sample:
creating, available, deleting, deleted
mount_point
str
 always
url of file system with leading dot from the time AWS EFS required to add network suffix to EFS address

Sample:
.fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/
mount_targets
list
 always
list of mount targets

Sample:
[{'mount_target_id': 'fsmt-d8907871', 'life_cycle_state': 'available', 'file_system_id': 'fs-a7ad440e', 'subnet_id': 'subnet-e265c895', 'network_interface_id': 'eni-6e387e26', 'ip_address': '172.31.17.173', 'security_groups': ['sg-a30b22c6'], 'owner_id': '740748460359'}, '...']
name
str
 always
name of the file system

Sample:
my-efs
number_of_mount_targets
int
 always
the number of targets mounted

Sample:
3
owner_id
str
 always
AWS account ID of EFS owner

Sample:
XXXXXXXXXXXX
performance_mode
str
 always
performance mode of the file system

Sample:
generalPurpose
size_in_bytes
dict
 always
size of the file system in bytes as of a timestamp

Sample:
{'timestamp': '2015-12-21 13:59:59-05:00', 'value': 12288}
tags
dict
 always
tags on the efs instance

Sample:
{'name': 'my-efs', 'key': 'Value'}


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as certified which means that it is maintained by an Ansible Partner. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by an Ansible Partner, see here.

Author

  • Ryan Sydnor (@ryansydnor)

Hint

If you notice any issues in this documentation you can edit this document to improve it.