Documentation

efs_facts - Get information about Amazon EFS file systems

New in version 2.2.

Synopsis

  • Module searches Amazon EFS file systems

Options

parameter required default choices comments
aws_access_key
no
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
no
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
no
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
no None
ID of Amazon EFS.
name
no None
Creation Token of Amazon EFS file system.
profile
(added in 1.6)
no
Uses a boto profile. Only works with boto >= 2.24.0.
security_token
(added in 1.6)
no
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
no None
List of tags of Amazon EFS. Should be defined as dictionary
targets
no None
List of mounted targets. It should be a list of dictionaries, every dictionary should include next attributes: - SubnetId - Mandatory. The ID of the subnet to add the mount target in. - IpAddress - Optional. A valid IPv4 address within the address range of the specified subnet. - SecurityGroups - Optional. List of security group IDs, of the form 'sg-xxxxxxxx'. These must be for the same VPC as subnet specified.
validate_certs
(added in 1.5)
no yes
  • yes
  • no
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

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 Return Values, the following are the fields unique to this module:

name description returned type sample
creation_token
EFS creation token
always str console-88609e04-9a0e-4a2e-912c-feaa99509961
name
name of the file system
always str my-efs
tags
tags on the efs instance
always dict {'name': 'my-efs', 'key': 'Value'}
size_in_bytes
size of the file system in bytes as of a timestamp
always dict {'timestamp': '2015-12-21 13:59:59-05:00', 'value': 12288}
creation_time
timestamp of creation date
always str 2015-11-16 07:30:57-05:00
life_cycle_state
state of the EFS file system
always str creating, available, deleting, deleted
file_system_id
ID of the file system
always str fs-xxxxxxxx
mount_point
url of file system
always str .fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/
number_of_mount_targets
the number of targets mounted
always int 3
mount_targets
list of mount targets
always list [{'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'}, '...']
performance_mode
performance mode of the file system
always str generalPurpose
owner_id
AWS account ID of EFS owner
always str XXXXXXXXXXXX


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 http://boto.readthedocs.org/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

Status

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

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.